From 386725000a5d43dce21db13ab2fa858d270a1877 Mon Sep 17 00:00:00 2001 From: tobspr Date: Sat, 9 May 2020 16:52:01 +0200 Subject: [PATCH] Update README.md --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ce84173c..6b218035 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,38 @@ # shapez.io -shapez.io source code + + +This is the source code for shapez.io, an open source base building game inspired by factorio. + +Your goal is to produce shapes by cutting, rotating, merging and painting parts of shapes. + + +## Playing + +You can already play it on https://beta.shapez.io + + +## Building + +- Make sure ffmpeg is on your path +- Install yarn and node +- Run `yarn` in the root folder, then run `yarn` in the `gulp/` folder +- Cd into `gulp` and run `yarn gulp`: It should now open in your browser + +**Notice**: This will give you a debug build with several debugging flags enabled. If you want to disable them, check `config.js` + + +## Contributing + +Since this game is in the more or less early development, I will only accept high-quality pull requests which add an immediate benefit. Please understand that low quality PR's might be closed by me with a short comment explaining why. + + +### Code + +The game is based on a custom engine which itself is based on the YORG.io 3 game egine (Actually its almost the same core). +Most code in the engine is clean with some code for the actual game on top being hacky. + + +### Assets + +You will need a texture packer license in order to regenerate the atlas. If you don't have one but you want to contribute assets, let me know and I might compile it for you. +