Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

Latest commit

 

History

History
74 lines (43 loc) · 4.38 KB

contribute.md

File metadata and controls

74 lines (43 loc) · 4.38 KB
layout title permalink
default
Contribute
/contribute/

How to contribute:

There are 2 primary ways you can contribute;

  • donating to the project,
  • helping with development.

Donation Links

[Patreon]({{ site.patreon_url }}){:target="_blank"}

[Paypal]({{ site.paypal_url }}){:target="_blank"}
(or send directly to: "{{ site.email }}")

Development

If you're a programmer, 2D artist, 3D modeler, musician, programmer, animator, soundcloud rapper, or especially a programmer, we need you!

To start on any of these, read the appropriate sections below which contains links to guides and task boards for those contribution types. Once you have a task in mind, contact a council member on our [Discord]({{ site.discord_url }}){:target="_blank"}.

The game itself is being developed in the Unity game engine. You can find what version of Unity we use and instructions on setting up our project on our [developer guide]({{ site.gitbook_url }}/dev-guide/){:target="_blank"}.

Our [GitHub organization]({{ site.github_url }}){:target="_blank"} has 4 main repositories.

  • [SS3D]({{ site.github_url }}/SS3D){:target="_blank"} - the game itself, and some documents.
  • [Art]({{ site.github_url }}/SS3D-Art){:target="_blank"} - art storage, with source files.
  • [Website]({{ site.github_url }}/SS3D-Website){:target="_blank"} - our (this) website.
  • [CentCom]({{ site.github_url }}/SS3D-CentCom){:target="_blank"} - api which manages user registration, authentication, and character storage.

For any other questions, concerns, or unsolicited advice, just ask around on the discord and someone will likely help you out.

Coding Tasks:

Start by familiarizing yourself with our [C# style guide]({{ site.gitbook_url }}/dev-guide/guidelines/the-c-style-guide){:target="_blank"}, and the rest of our [developer guide]({{ site.gitbook_url }}/dev-guide/){:target="_blank"}.

Feel free to help on any of our 3 repositories as they could all use your help, but since most of you are here to help with the game itself, visit the SS3D [Issues page]({{ site.github_url }}/SS3D/issues){:target="_blank"} and use the labels to help find a task you are interested in.

3D Modeling Tasks:

Start by downloading our Modeler’s Kit{:target="_blank"} folder, and check out our [3D Art Guide]({{ site.gitbook_url }}/art-guide/3d).

Then visit our models board{:target="_blank"} for general models and the rig models board{:target="_blank"} for models related to rigging (characters, clothes, vehicles, etc.)

We recommend using Blender{:target="_blank"} as it's free and open-source, thus it's easily accessible by most people, and as a result our modeler's kit is mostly designed for use with Blender.

3D Animation Tasks:

Start by deciding on a task from our animations board{:target="_blank"}. Then see our [Animation Guide]({{ site.gitbook_url }}/art-guide/3d/animating).

If it's related to the character rig, we have a Character Animation Kit{:target="_blank"} but it's currently only set up for Maya users, although you can use Blender to animate too.

2D Art Tasks:

Visit our 2D board{:target="_blank"} to find a task to work on and then visit our [2D Art Guide]({{ site.gitbook_url }}/art-guide/2d).

Sound Tasks:

We currently do not have any guides for SFX, but if you want to scream like a psychopath or fart into a microphone, check out our sfx board{:target="_blank"}.

Submissions:

Technical contributions are submitted to [our game repo via pull request]({{ site.github_url }}/SS3D/pulls){:target="_blank"}.

Art contributions currently are submitted via the art channels in our [Discord]({{ site.discord_url }}){:target="_blank"} server.

Licensing:

This project and its code fall under the [MIT license]({{ site.github_url }}/SS3D/blob/master/Documents/LICENSE-CODE.md){:target="_blank"}.

All asset contributions fall under the [CC BY-NC-SA 4.0 license]({{ site.github_url }}/SS3D/blob/master/Documents/LICENSE-ASSETS.md){:target="_blank"}.