You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
tobspr 57678664d4 Fix DOM token error in watermark 5 days ago
.github/workflows Fix/achievements (#1091) 1 year ago
.vscode Merge base-*.yaml & fix YAML lint errors and warnings. (#918) 2 years ago
electron MacOS Support 1 month ago
electron_wegame Mod Support - 1.5.0 Update (#1361) 4 months ago
gulp Demo adjustments, fix missing dependency 1 month ago
mod_examples Add smooth_zooming mod example, Fix UI toggle, (hopefully) fix vram issues, add latest discounts 5 days ago
res Promote current discount 1 month ago
res_raw Update blueprint previews 11 months ago
src Fix DOM token error in watermark 5 days ago
translations Fix a grammar mistake in the french translation (#1408) 2 months ago
.editorconfig Added EditorConfig (#778) 2 years ago
.eslintignore add all GH Actions work 2 years ago
.eslintrc.yml Update github actions 2 years ago
.gitignore MacOS Support 1 month ago
.gitpod.Dockerfile simplify code contributions + reviews by fully automating the dev setup with Gitpod. (#824) 2 years ago
.gitpod.yml simplify code contributions + reviews by fully automating the dev setup with Gitpod. (#824) 2 years ago
.prettierrc.yaml Update github actions 2 years ago
.travis.yml Update travis 2 years ago
.yamllint Fix yaml errors in CI (#757) 2 years ago
CONTRIBUTORS Add artwork folder and list of contributors 2 years ago
Dockerfile Fix Dockerfile (#1409) 2 months ago
LICENSE Update license 2 years ago
README.md Update readme 3 months ago
package.json Mod Support - 1.5.0 Update (#1361) 4 months ago
shapez.code-workspace Allow to cycle variants backwards with SHIFT + T, other fixes and misc stuff 1 year ago
sync-translations.js Update translations 1 year ago
version Pass variant and rotationVariant to getIsReplaceable 3 months ago
yarn.lock Mod Support - 1.5.0 Update (#1361) 4 months ago

README.md

shapez.io

shapez.io Logo

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.

Reporting issues, suggestions, feedback, bugs

  1. Ask in #bugs / #feedback / #questions on the Official Discord if you are not entirely sure if it's a bug
  2. Check out the trello board: https://trello.com/b/ISQncpJP/shapezio
  3. See if it's already there - If so, vote for it, done. I will see it. (You have to be signed in on trello)
  4. If not, check if it's already reported here: https://github.com/tobspr/shapez.io/issues
  5. If not, file a new issue here: https://github.com/tobspr/shapez.io/issues/new
  6. I will then have a look (This can take days or weeks) and convert it to trello, and comment with the link. You can then vote there ;)

Building

  • Make sure ffmpeg is on your path
  • Install Node.js (v16 or earlier) and Yarn
  • Install Java (required for texture packer)
  • Run yarn in the root folder
  • cd into gulp folder
  • Run yarn and then yarn gulp - it should now open in your browser

Notice: This will produce a debug build with several debugging flags enabled. If you want to disable them, modify src/js/core/config.js.

Creating Mods

Mods can be found here. The documentation for creating mods can be found here, including a bunch of sample mods.

Build Online with one-click setup

You can use Gitpod (an Online Open Source VS Code-like IDE which is free for Open Source) for working on issues and making PRs to this project. With a single click it will start a workspace and automatically:

  • clone the shapez.io repo.
  • install all of the dependencies.
  • start gulp in gulp/ directory.

Open in Gitpod

Helping translate

Please checkout the Translations readme.

Contributing

I will only accept pull requests which add a benefit to a large portion of the player base. If the feature is useful but only to a fraction of players, or is controversial, I recommend making a mod instead.

If you want to add a new feature or in generally contribute I recommend to get in touch on Discord in advance, which largely increases the chance of the PR to get merged:

discord logo

Code

The game is based on a custom engine which itself is based on the YORG.io 3 game engine (Actually it shares almost the same core). The code within the engine is relatively clean with some code for the actual game on top being hacky.

This project is based on ES5 (If I would develop it again, I would definitely use TypeScript). Some ES2015 features are used but most of them are too slow, especially when polyfilled. For example, Array.prototype.forEach is only used within non-critical loops since its slower than a plain for loop.

Assets

For most assets I use Adobe Photoshop, you can find them here.

All assets will be automatically rebuilt into the atlas once changed (Thanks to dengr1065!)

shapez.io Screenshot

Check out our other games!

tobspr Games