Welcome to MapsNotIncluded.org
A fully opensource alternative to ToolsNotIncluded.net by Cairath
- RoboPhred - Thank you for your contributions to parsing and understanding ONI saves
- Stefan Oltmann - Thank you for the web interface to parse ONI saves that was made fully open source, and directly contributing to this project in support and development.
- Sgt_lmalas - Thank you for building an awesome world generation mod, which largely inspired our first version, until you made changes specifically for us, hope we can keep annoying you for more for a long time!
- Cairath - Thank you for giving the community such a wonderful tool for years and years with no expectation of payment. We hope one day to collaborate directly together! Also thank you for your administration of the Discord server and for the guides written for modding ONI!
- To @pardeike, creator of Harmony, the library that made modding ONI possible.
This project is still in its infantsy, if you'd like to contribute please either: Raise an issue, submit a PR or join our Discord.
There is a docker-compose.yml file that should allow you to get up and running quickly, note it may be out of date at times, ping us on Discord if this is the case!
If you've never used docker before, simply install and run the following command in your favourite flavour of terminal, and you should have a full copy of MapsNotIncluded. You are advised to check out the docker-compose.yml file to see what environment variables are required, and
docker compose up
The main parts ongoing here are:
- Frontend
- App
- Mod
- Ingest Service
- Hash Service
The 'Frontend' is the 'main' user interface that currently acts as parent to Steps' and Sgt's work - these are currently iframed in. I would recommend implmenting UI changes here if possible, but if not you are welcome to create a project in your own framework flavour which if opensource, we can iframe in as a separate 'module'.
The 'App' is a general NodeJS api, and is for day-to-day api calls such as requesting a seed.
The 'Mod' is what you run on your PC, on Discord we have a few dedicated contributors that run this mod 24/7, it is responsible for automating the OxygenNotIncluded worldgen and submitting the resuts to the Ingest Server
The 'Ingest Service' is again hosted over on Steps' github, but it is the URL endpoint the Mod will call to submit seeds. This service also currently hosts some APIs for Steps' own user interface. You may find reminants of ingest in the app code that hasn't been removed just yet.
The 'Hash Service' is used to automate the process of getting OxygenNotIncluded hash files, we use this to verify the integrity of the worldgen files with the latest game updates.
This project is completely open source and free, there is no expected payment or donations. In future donations may be accepted to support server costs but the full functionality will be unrestricted forever.
It might! My plan is to be fully open and transparent, all of the services will be deployable via Docker and periodic exports of the database will be automatically shared on the discord, and the website, we hope to share them in more places too as it becomes more valuable
This is a hobby project, so anything goes at this stage. Please just ensure your code is somewhat readable, please go for more lines over single lines for readability. Please use widely accepted libraries where possible to maximise those who can contribute, and please try to avoid complex logic flows. This is not enterprise.
Please ensure all code remains cross-platform for as long as possible.