Only this pageAll pages
Powered by GitBook
1 of 10

Management

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Bounties

Bounty management

How to set up and value bounties.

Dev Bounties
Art Bounties

Community Rules & Moderation

Outlines our community rules and how to moderate them.

(this document needs to be expanded more)

You can find the communities we are responsible for moderating under the Sites & Accounts page, but this also expands to all our sites including comments on our GitHub repositories, Trello boars, YouTube channel, etc..

Rules

  1. Don't be a dick

  2. No NSFW content or other forms of degeneracy.

CentCom Responsibilities

CentCom Member Responsibilities

There are 3 distinct areas of responsibility: designing, implementation, and management.

Preface - Terms

Repositories - Place where code & assets are stored (e.g. GitHub).

Task - A piece of implementation work (i.e. coding a piece of a feature or making an asset).

Boards - the primary board is the GitHub implementation board, though we have other boards on Trello for asset todo tasks as well as a management board.

Wiki - Repository's Wiki (this has ben moved here to our gitbook but the term hasn't been updated throughout our documents fully yet).

Chat - The official place where communication takes place, in our case the Discord server.

Responsibility - Designing

The team must collectively agree upon the features of the game before they can be implemented. Additionally, community opinion must be considered during design and designed features must be publicly viewable.

Process

  1. An idea is placed into the design board's backlog and prioritized.

  2. The most prioritized idea is put into in-design. A wiki document is made for it where members of the team start writing up the design.

    • Team members should not erase text without general agreement.

    • Documents should be in-design at least long enough for most of the team to contribute.

    • Controversial pieces should be open for community involvement and discussion so that they can influence the outcome. This could be done by vote or announcement in Chat.

  3. Once the document is complete it is put into review, where any final problems are discussed.

    • Any existing problems can be mentioned in the wiki document, in a separate section.

    • [optional] The community can vote (in Chat) on whether or not to accept the feature.

    • The review finishes when a majority vote passes on the decision.

Permissions & Tooling

The dev board must have columns for backlog, in design, in review, and complete. The wiki must have a section for writing feature designs. The chat must have a way for team members to create votes and announcements, and team members must be able to read and respond to community voices in the chat.

All team members have permission to read and modify the board and the wiki. The public has permission to read the board and wiki.

Responsibility - Implementation

The team maintains the quality of the assets, the GitHub repositories, and maintains the boards both on GitHub and Trello. Additionally, team members can assign people to work on specific tasks.

Unlike designing, this responsibility is more individual - collective agreement is not required for many of the tasks.

Processes

  • Team members (somewhat collectively) take designed features and turn them into tasks in the backlog.

  • Team members (somewhat collectively) prioritize tasks in the 'backlog' and 'available' columns.

    • Available tasks are ones people can work on, backlog needs to be done but aren't meant to be worked on yet.

  • Team members decide when to move the (top prioritized) tasks from 'backlog' to 'available'.

    • Tasks could be moved to ensure the available column has X amount of work in it.

  • Any team member can assign an available task to anyone, and move the task to in-progress.

  • Any team member can review a task that has been completed.

Permissions & Tooling

The implementation boards should indicate what tasks are available and unavailable to work on, in progress (and who is assigned to them), being reviewed, and what tasks are complete. Tasks that fail their review go back to being in-progress, tasks that pass their review should be immediately be placed in their respective repository. With GitHub, a lot of the above steps can be automated (e.g. accepted reviews being placed in the Done column). Additionally, GitHub can require PRs for tasks before merging.

Team members have permission to modify the boards, review and merge PRs to the repositories, as well as all public permissions. The public has permission to read the board and repositories, request to be assigned tasks, and submit PRs.

Responsibility - Management

The team chooses collectively who is on the team. There can be some rules relating to promotion/demotion that are generally agreed on.

  • When choosing to promote or demote someone, enough time must be given for most team members to voice their opinions.

  • There could be an indiscriminate demotion for inactive members after 2+ months of no development (management or submissions) and/or 1 month of inactivity in chat. If a demoted member starts contributing again, they could be repromoted again through the same process as before.

Art Bounties

That'll be a thing at some point !

Management Intro

Info for SS3D management staff.

Documents relating to the management team.

Sites & Accounts

These are all of the sites we use for Space Station 3D.

Our Website

Developed on our "Website" GitHub repo (see GitHub section below).

The domain name is currently owned and paid for by Grimmie (or Judge on our Discord).

Development

GitBook

Most of our wiki and documents have been moved here.

GitHub

GitHub Repositories:
  • Art - the repository for all of our art assets. This is helpful because we store the source files for the assets here, making them easier to edit in the future.

  • Website - is what it sounds like, it's the repo for our website, which hosts our monthly devblog as well as various information and contribution guides.

  • CentCom - is the repo for our central communications server, which manages user registration, authentication, and character storage, similar to what Byond is to SS13.

  • SS3D - is our main repo which is the repo for the game itself as well as the implementation board (for technical tasks) and this wiki.

GitHub Owners:
  • CosmicCoincidence

  • John

  • Probably Not

Trello

Trello Boards:
  • Management - used for management tasks.

  • Ideas - used to store ideas about game systems or content.

  • Models - 3d model tasks.

  • Rig Models - 3d model tasks of models that will require rigging.

  • Animations - tasks for 3d animations.

  • 2D - for 2d graphic and texture tasks.

  • VFX - tasks for visual effects like shaders.

  • SFX - tasks for sound effects or music.

The Trello team consists of all of the members of the council. In addition, some more trusted contributed have write access on some boards (e.g. Konstantin3001 has access to the 2D board).

Google

Gmail

ress3d.project@gmail.com

Used for opening other accounts and general emails.

GoogleDrive

GoogleDrive is used as a dropbox for submitted assets, which are then reviewed and prepared for use prior to being moved into the GitHub project. In addition, CentCom uses the GoogleDrive for hosting other things like artwork and documents.

All assets saved here fall under our art license (CC BY-NC-SA 4.0).

YouTube

For posting development tutorials, tests, new content, art, etc..

Communities

Discord

Discord is the official method of communication for the SS3D community and devs. This includes posting WIP content for criticism and discussing game designs. There are also many people willing to help in various genres of game development.

CentCom members and mods moderate the Discord. CosmicCoincidence is the owner.

Reddit

Reddit is for posting announcements, memes, WIP, art, etc..

Currently owned by Grimmie, and moderated by various CentCom members.

Twitter

For posting devblogs and occasional funnies.

Mostly run by ProbablyNot.

Financial

PayPal

PayPal is our monetary hub, all donations get funneled and recorded here prior to be distributed to project costs. When donating to the PayPal, you can use the link provided or send money directly to our email (ress3d.project@gmail.com)

Patreon

Where you can subscribe to us and donate a small amount each month. This money gets forwarded to the PayPal.

Devblog

Devblog creation process.

Devblogs are usually made by CosmicCoincidence but this page is written so that any team member (or contributor really) can make it.

Currently devblogs are being made quarterly, but as progress picks up again we may switch back to monthly.

Simply put, the idea is to showcase all (note-worthy) contributions during a given period, but it's a bit of a process (you will need to know for this):

Step -1: Foresight

If you know in advance that you will be responsible for creating the devblog, then I highly recommend you to follow the github repos & contribution channels in the discord throughout the month/quarter, so that you are more familiar with them when the time comes to write about them. Also ask contributors to provide photos/videos of their work in advance so you don't need to do it yourself.

Step 0: New Release

Make sure a new release has been made recently. If automated releases haven't been configured yet, and you are the one responsible for the making the the devblog, then you are also likely responsible for make the release manually. See the release page for info.

Step 1: Blog - Set Up
  1. Fork the if you haven't already.

  2. Open & read the "devblog-format.md" file in the "_drafts" folder. This file details how to format the blog file itself. You can use it or another devblog file (in the "_posts" folder as a template for your blog file.

  3. Name your file like so: year(full)-month-30-year(short).month and place it in the "_posts" folder. (The month in question is the month you are writing the blog, it is for the month you are writing about. If the blog is a quarterly blog, use the last month of the quarter here.)

  4. Follow your template file and fill in the 'title' and other variables. The 'title' should look like year(short).month if a monthly blog; or year(short).month-month if a quarterly blog, first 'month' representing start of the quarter, second 'month' representing the end. The 'release' should match the tag of the latest GitHub release made in . Also, don't change the time...

Step 2: Blog - Contributions

*Make sure all contributions are credited!*

Art Contributions:

Must be submitted via the art channels on discord or merged to the game (SS3D) or art (SS3D-Art) repos (if submitted via discord, add the submissions to the and credit the file with the contributor's name in the credits file).

Art contributions usually don't need much explanation so a sentence for each usually will suffice. These should always have some media (image or video) to display.

Technical Contributions:

Must be submitted via merged to one of our github repos.

Technical contributions are usually split into 2 types; large ones are given their own sections with more detailed explanations and maybe even media, small ones are collected into the 'Details' section and listed by contributor name.

Media:

Place the artwork in /assets/img/art/[contributor]/.

Place the other media in /assets/img/posts/[period]/.

  • photos must be 800x600px resolution unless they are artwork (like wallpapers or logos).

  • videos must be 800x600px or 1280x720px resolution to be added to the site directly (other resolutions can be uploaded to youtube and linked otherwise).

  • media must be named accordingly (e.g. 'Contributor_Contribution.media')!

Extras:

  • Add artwork to the "art.md" page too.

Step 3: Pull Request

Make your pull-request to the 'release' branch and wait for a @Centcom or @Website-Maintainer to merge it.

Finances

Monetary management

This document outlines our projects income and costs.

(add more to this document later)

Income:

Any money being RECIEVED by the project.

Income Sources:

  • Patreon - subscribers.

  • PayPal - direct donations.

  • YouTube - not set up yet.

Our current income sums up to about $50 per month.

Expenses:

Any money being SPENT by the project.

Expense Sources:

  • Website - Currently being paid for by Grimmie.

  • Server - We do not currently host a server so this isnt relevent yet.

  • Bounties - Bounties are how we pay/tip our developers for contributing certain tasks. See the Bounties page for more info.

  • John's Salary - We are currently paying John $100 a month for putting is the amount of effort he is, especially considering the latest rework.

website repository
Step: 0
googledrive

Gitbook and Github Syncing

GitBook Backup repo

Do NOT enable the "Install on all spaces" option in the integration menu. It will break the current integrations and mess up a bunch (made this mistake once already). Each space must be enabled individually.

Gitbook and Github are automatically syncing, at for all of our current spaces. The syncing allow us to have a backup of our gitbook data in case of a catastrophic lost. Any space added later will need to be configured to sync.

Do NOT modify files directly on github unless you know what you're doing! It syncs BOTH ways!

If you add another space, follow the doc here to sync it. https://docs.gitbook.com/integrations/git-sync/enabling-github-sync

When syncing another space, don't let the root folder by default, otherwise it'll make a mess on github.

Add a folder with the same name as the space you created.

For this space, here's the project directory:

Dev Bounties

Eligibility

Conditions for a task to have a bounty are :

  • It's part of the current milestone.

  • It must be clearly detailed. - If it's a bug, some attempt must be done to fix it before.

Bounty price

The price of the bounty will be fixed by a Centcom member, by estimating how time consuming it will be :

  • Full new system (90 dollars) :

    • Implementing every aspect of a complete major system design doc.

  • Major rework / Major feature (60 dollars) :

    • Major rework : Heavy changes on an existing system, full reorganization, significant boost in performance/readability/re-usability.

    • Major feature : Adding some lengthy and complex classes/struct/prefabs, complex methods.

  • Minor rework / Minor feature / Major fix (30 dollars) :

    • Minor rework : Changing a chunk of an existing system, a few classes/methods.

    • Minor feature : Changing a few classes, adding small classes.

    • Major fix : Fix impacting multiple systems and hard to solve.

  • Minor Bug fix / Small feature (15 dollars) :

    • Minor Feature : Small change to existing code.

    • Minor bug fix : bug that doesn't affect multiple system, that can be solved in a few changes (usually a few lines).

Claiming a Bounty

Anyone can claim a bounty. Bounty claimers have to show regularity in their progress to keep the bounty claim. After two weeks of inactivity (no substantial commit or change to a design doc), and if no justification is provided, anyone else can claim the bounty, on a decision of a Centcom member. One person can't claim two bounties at the same time, they can only work on one bounty task at once.

Bounty price modification

Bounty price can be modified when a pull request is ready and only upon accepting a pull request. The bounty price can only go up. As an example, if what was believed to be a simple bug fix, actually needed a major rework, then the bounty price will be adjusted to reflect fairly the work of the contributor. The decision is taken by a Centcom member.

GitHub