Archives/tobspr_shapez.io
1
0
Fork 0
mirror of https://github.com/tobspr/shapez.io.git synced 2025-12-11 09:11:50 +00:00
Code Issues Projects Releases Wiki Activity
c2855d528d
tobspr_shapez.io/README.md
Даниїл Григор'єв c2855d528d
Slight improvements for the build process (#19) 
* Unify the version source

Changes the development config to use version from package.json and
makes the production config use the same utility function. Also removes
the version file as it's no longer needed.

* Remove some Steam references from build process

Removes files needed to publish the game on Steam and related tasks that
can be only used by the developer anyway. Only the build process is
affected, the actual game part still supports Steam integration.

* Refactor/add packaging tasks

Adds new Gulp tasks to create a distributable package of the game. A
task for macOS is not provided because signing needs to be figured out
first. Package creation tasks are also aliased in package.json for
future usage in external tools or CI. Aside from that, alternative
methods of downloading the libGDX Texture Packer are dropped.
2024-04-14 19:03:27 +03:00

4.6 KiB
Raw Blame History

shapez Community Edition shapez Logo

shapez Community Edition (abbreviated as CE) is a community-maintained version of shapez!

CE was created as the tobspr Games team moved away from shapez to work full-time on the upcoming Shapez 2. CE aims to:

  • Continue the development of shapez as guided by the community.
  • Allow contributors to continue submitting new features and improvements to the game.
  • Provide an experimental and forgiving environment for faster development.

Important

CE is different from the official game published on Steam and other platforms. CE was forked off of the official shapez, which has its own repository. No plans exist to merge the two versions of shapez.

As of now, CE must be built from source and supports only a standalone build, with no plans for re-supporting a web version. In the future, builds of CE may provided for owners of the full version of shapez.

Contributing

We communicate on the official shapez Discord server. For historical reasons, we have communicated in a private channel, but we are moving to the public #contributing channel. If you would like to contribute to CE, feel free to share your ideas, plans, etc. there.

In our current workflow, we (the "collaborators" of the repository) create internal branches and corresponding pull requests to work on a feature, refactor, etc. We discuss changes in the Discord, and when 2 collaborators (including the PR creator) approve of a change, it can be merged. See our existing pull requests for examples.

If you are not a collaborator and want to submit a change, you can fork our repo and make a pull request. Note that because of plans to overhaul many parts of the game, unless you are improving translations, you should probably communicate with us on Discord!

Tip

Be aware that pull requests to the official shapez repository are unlikely to get merged in the near future. Instead, submit them to CE! In fact, because the game is licensed under the GNU GPL v3.0, existing pull requests can be resubmitted to CE even if you aren't the author! This is not legal advice.

Code

The game uses a custom engine originally based on the YORG.io 3 game engine. The code within the engine is relatively clean with some code for the actual game on top being hacky.

We are in the process of migrating to TypeScript and JSX/TSX. New changes should be implemented in TypeScript if possible, but because we are planning on overhauling many parts of the game, there is no need to convert existing code to TypeScript.

This project is fine with using cutting-edge and bleeding-edge features and does not intend to provide compatibility for older clients.

Building

Prerequisites

Development

  • Run yarn in the root folder and in electron/.
  • Run yarn gulp in the root folder to build and serve files. Ignore the browser tab that opens.
  • Open a new terminal and run yarn startDev in electron/ to open an Electron window.
    • Tip: If you open the Electron window too early, you can reload it when focused on DevTools.

Release

Important

While there is partial macOS support, it is not tested and adapted yet. Therefore, macOS package creation task is not provided.

  • Run yarn in the root folder and in electron/.
  • In the root folder, run yarn package-$PLATFORM where $PLATFORM is win32 or linux depending on your system.
  • The build will be found under build_output/standalone-steam as shapez-...-x64.

Credits

Thanks to tobspr for creating this project!

tobspr Games

  1. cURL is already installed on most Windows, Linux and macOS systems. ↩︎