https://rogueworld.io/
Contents
- Introduction
- Getting started
- Contributing
- Tooling
- Development setup
- Guides
- Attribution
- Links and resources
Introduction
Greetings!
This area is intended for potential contributors who are interested in the project, but don't know where to begin. Any info that someone might want to find about joining and working on the project will probably be here somewhere, and if not, let me know and I'll update this documentation.
Rogueworld is open-source, meaning that anyone is free to see all aspects of how the game works on a technical level, and can also contribute to the project, such as adding new creatures, items, balancing, fixing bugs, and whatever else will make the game better.
Here you can find basically everything that goes into the game, what is currently being worked on, and how you can help!
The creation of Rogueworld is a collaborative effort, with content and mechanics able to be added by members of the community.
It is a non-commercial project, so there are no promises of "rev-share" or "backpay when the game makes money" or whatever. That isn't the goal here. This project is ideal for beginners, hobbyists, students, portfolio builders, work experience seekers, and of course regular players of the game curious to see how the magic happens.
Getting started
First, you should have played the game to get a feel for what it is like, what has been done so far, what looks lacking, and to generally get a good context for what you might want to get started with.
The main contribution areas are code, audio, visual, with other smaller ones like balance, translations and testing.
You probably came to this project already specialising in one of these. There are guides tailored for contributors that describe the general requirements for each field, that you can jump to if you just want to skip whatever doesn't apply to you.
Contributing
With so many moving parts to a video game, especially a one like this, it is important to keep the project managed well. I try to run the project like you would find in an actual software company, where each thing being worked on should be detailed, tracked, completed (or cancelled), tested and finally added to the game.
This is done using the main tasks backlog on the GitHub issues page.
Tasks backlog: https://github.com/Arcanorum/rogueworld/issues
There you can filter by whatever topic interests you using the tag filters.
This is where pretty much everything that is proposed to change about the game should start.
From there, any tasks that are to be grouped together into a larger piece of work, such as a new major feature, will be organised into the project trackers for the major things that are being worked on.
Project trackers: https://github.com/Arcanorum/rogueworld/projects
Once you have found something you want to have a go at, you should let me (or other GitHub project admin) know that you want to start something so it can be marked as in progress, so multiple people don't start the same thing. Don't just randomly submit PRs out of nowhere.
Tooling
"What engine is the game made with?"
This game doesn't use an off the shelf game engine/centralised project manangement GUI, like Unity, Unreal, GameMaker, etc.
As a game that is also a website, it uses many of the tools of the web development trade. The "engine" is a custom setup that brings together various tools that are all free, widely used, and reasonably well documented, that are each specialised for a certain task.
To be able to run and edit the game yourself on your own computer, there is a setup guide that should provide a quick and easy set of instructions to get everything working with minimal messing about, though general web development knowledge will be needed to be able to do any non-trivial tasks.
Though, setting up and running the game on your own computer is not necessary for many kinds of contributions.
A lot of tasks are fairly self contained, mainly creating assets (sprites, sounds), and can just be passed to someone else who does have the rest of the project set up, to integrate into the game on your behalf.
To let people see what the implemented asset is like in game, there is a public test server that is updated with recent work much more often than the live game, and is used for faster turnarounds for testing and feedback, before things go into an update for the live game.
Public test server: https://test.rogueworld.io/
Development setup
See this guide for going through setting up the project and getting it running on your computer.
Guides
"I want to add a..."
Features are divided into two general categories:
Mechanics:
Things like movement, collision, creating entities, AI, new systems, etc. that affects the fundamental flow of the game. Due to how they are often intricately tied to many other things, it is recommended to get some familiarity with the core components of the codebase first and the most common workflows (creating items, creatures, actions), then look for something appropriate in the tasks backlog that has been sufficiently planned out and ready to be worked on.
Content:
Things that make use of existing mechanics to give players stuff to do, such as points of interest to explore, resources to gather, items to craft, creatures to fight, structures to build, etc.
Below are guides for each, where you are encouraged to think of something different to add instead of just the examples given and to experiment with each step of the guide, so you aren't just copying the guide without understanding what is happening.
Attribution
Proper attribution of all work is expected. This includes original creations submitted by contributors, and anything used from somewhere else (such as opengameart.org or other asset sharing resource).
The credits page for the game lists the currently used assets for the game, and should be updated when new things are used by the project by more authors.
Credits page: https://test.rogueworld.io/credits/
A "work" or "works" is a piece of artistic work you have created, such as textures, sprites, sound effects, music, story/lore, etc.
This project uses the MIT license, and as such can be copied, modified, redistributed, and even used commercially by anyone. Any works you wish to submit will also be included under the project's MIT license.
Under MIT, attribution is not required, but is given anyway as a courtesy.
An attribution may (but doesn't have to) include:
- The specific works you did.
- Your name and/or nickname/alias.
- A link to your website, portfolio, or other profile.
For example:
Scamp character animation by Arcan (https://github.com/Arcanorum)
You should be asked how you want to be credited when you submit something.
However, if you do not agree to the MIT terms for your submissions, you can submit them using another license that suits your needs, and that one shall take precedence.
For example, if you want to require attribution (credit) for use of your work by anyone else who uses it (such as someone taking the work and using it in another game), you probably want to use one of the CC-BY licenses (https://creativecommons.org/about/cclicenses/). This can be discussed with a project maintainer (i.e. Arcan) as needed.
Links and resources
- Test server
- Discord server
- NodeJS (JavaScript runtime)
- MongoDB (player accounts DBMS)
- Phaser (frontend rendering, input & audio playback framework)
- NextJS (frontend GUI and build framework)
- Free Texture Packer (texture packer)
- Tiled (map editor)
- Translations spreadsheet