philg-dev / industryidle

Source code for Industry Idle

Industry Idle

Industry Idle is an idle game that combines factory building, resource management and market trading. Design & build your base, expand & scale up your productions, improve & optimize your economy. Plus all the incremental game goodies: offline earnings, prestige to unlock more powerful upgrades.

• Play on Steam (Windows/Mac/Linux)
• Play on iOS
• Play on Android
• Play on Web
• Join Discord

Get Involved

Join our discord #industry-idle-dev to discuss about the development

Localization

All translations are done by the community. If you'd like to help, visit here for more info.

Bugfix

Fork the repository, and submit a PR. Ping me (FishPond#7427) on Discord if you need help.

New Features

If you want your feature to get merged and released, please discuss with me (FishPond#7427) on Discord before implementing the feature. Features that benefit majority players (e.g. QoL improvements) are very likely to get merged. Features that affect game balances needs to be carefully discussed and tested.

Development

To build the game, you need:

• Cocos Creator 2.4.x. Check here for the version used by the game. Please get this exact version as different versions of Cocos Creator often introduce incompatibilities.

• Node.js 16 LTS with TypeScript

• ESlint and Prettier

• I recommend VSCode as editor/IDE but you are free to use your own

There are two submodules in this repository - they contain private modules - you do not need them for development. However, you do need to create a config file in assets/Script/Config/Config.ts. (You need to create the Config folder). A sample content has been provided here.

After that, you should be able to open the project in Cocos Creator and run the game. Most of the game logic are in assets/Script/ folder. Game arts are in assets/resources/ folder.

Before you commit and submit a PR, make sure your code:

• does not have TypeScript compiler error
• does not have ESLint warnings
• is formatted by Prettier using the rule in the project

About Server Anti-Cheat

To make development easy, the development code can connect to the game's trading server. However, the account will not be "authenticated" (meaning certain trading restrictions apply). Please also refrain from submitting test trades to the server as it will most likely causes anti-cheat flag.

License

• Game's source code is licensed under GNU General Public License v3.0.
• Third party libraries are licensed under their corresponding licenses.
• Game's artworks and assets are included in this repository. However, due to the complications of the original licenses, please do not redistribute them.