Git Product home page Git Product logo

foc- / shapez-community-edition Goto Github PK

View Code? Open in Web Editor NEW

This project forked from tobspr-games/shapez-community-edition

0.0 0.0 0.0 647.45 MB

The community edition of shapez, maintained by community contributors!

Home Page: https://get.shapez.io/gh

License: GNU General Public License v3.0

Shell 0.01% JavaScript 86.82% Python 0.13% TypeScript 1.81% CSS 0.23% HTML 0.56% Batchfile 0.02% Dockerfile 0.03% SCSS 10.38%

shapez-community-edition's Introduction

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

Caution

Release steps are currently unchecked and unmaintained and will likely be revised in the future.

  • Run yarn in the root folder and in electron/.
  • In the root folder, run yarn gulp build.standalone-steam.
  • Run yarn gulp standalone.standalone-steam.prepare.
  • Run yarn gulp standalone.standalone-steam.package.$PLATFORM where $PLATFORM is win64, linux64, or darwin64 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

shapez-community-edition's People

Contributors

astavie avatar baxxster avatar bjornstar avatar demivan avatar denapo avatar dengr1065 avatar derfeldspatz avatar dimava avatar dj1tjoo avatar emeraldblock avatar enderdoom77 avatar gumball73 avatar hexagonhexagon avatar isaisstillalive avatar jaysc avatar killgaru avatar leopoldtal avatar magos avatar mattgibney avatar mini-bomba avatar omemi-test avatar pedrorajao avatar pepperoach avatar pequenolyo avatar phlosioneer avatar revoscz avatar ryoncai avatar sense101 avatar tobspr avatar xsparfuchs avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.