Minespree Documentation

This repo contains all the internal documentation, guides and codebooks that developers used to get setup to work on the former Minespree Network. This repo should be the starting point for replicating the original network as there are guides on most of our internal systems.

Please note that these docs were written to onboard new developers and there might be missing bits you don't have access to.

• Getting started
  • Required Dependencies
  • GitLab setup
  • IDE setup
  • SSH Tunnels
  • Connecting to MongoDB databases
  • Artifactory setup
• Using PlayPen
  • What's PlayPen?
  • Connecting to a network
  • Packaging artifacts
  • Manually deploying a package
  • Setting up your own network
• Automatic testing and deployment
  • How the playpen-packages repo works
  • Auto-test and auto-deploy a project
  • CI PlayPen Runner Docker image
• Octopus panel
• Rise
  • Creating your first game

License

Docs is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

A copy of the GNU Affero General Public License is included in the file LICENSE, and can also be found at https://www.gnu.org/licenses/agpl-3.0.en.html

The AGPL license is quite restrictive, please make sure you understand it. If you run a modified version of this software as a network service, anyone who can use that service must also have access to the modified source code.