A 3D client for the MMORTS Screeps.com
To build a 3D client for Screeps.
It has a fairly solid foundation so that if anyone wants to contribute to it, it is at a good point. There is a websocket/http client that could be fleshed out more but has all the basic functionality. There is a solid system for rendering rooms/objects. At the moment the project is organized into two systems:
It would be ideal to keep these two separate, so that the ScreepsAPI can be exported as a package for use in other screeps/unity3D projects.
Scroll to the bottom for a feature comparison with official clients
Here are the major areas that we would like to tackle next:
Want to try the client?
Download a release from the release page
Official client needs an auth token https://docs.screeps.com/auth-tokens.html
Private server needs two mods.
Currently you need to press the "Save" button to connect to allow it to persist credentials, will be reworked later.
The Project is built using Unity and C# so the following software is required to run it.
After installation you can open the project in unity, and in the asset menu you can "Open C# Project" to open visual studio
The C# Solution is constructed every time you open the project with Unity.
Merges in git
git mergetool
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. If there is an existing issue you would like to tackle, please mention that in the issue to allow others to collab with you :)
You can also join the official screeps discord and participate in #screeps3D
This is an attempt at a feature comparison table.
Feature | Official | 3D |
---|---|---|
Connect to official server | :heavy_check_mark: | :heavy_check_mark: |
Connect to private server | :heavy_check_mark: | :heavy_check_mark: |
Simulation | :heavy_check_mark: | |
Visualization of nuke arcs | :heavy_check_mark: | |
Nuke list | :heavy_check_mark: | |
Market | :heavy_check_mark: | |
Overview | :heavy_check_mark: | |
Stats | :heavy_check_mark: | |
Room View | :heavy_check_mark: | :heavy_check_mark: |
Seamless transition to rooms | :heavy_check_mark: | |
Map View | :heavy_check_mark: | :heavy_check_mark: |
Spawn invaders | :heavy_check_mark: | |
Place spawn | :heavy_check_mark: | :heavy_check_mark: |
Place construction sites | :heavy_check_mark: | :heavy_check_mark: |
Place flags | :heavy_check_mark: | :heavy_check_mark: |
Room Visuals | :heavy_check_mark: |
Object | Official | 3D |
---|---|---|
construction site | :heavy_check_mark: | :heavy_check_mark: |
creep | :heavy_check_mark: | :heavy_check_mark: |
deposit | :heavy_check_mark: | :heavy_check_mark: |
flag | :heavy_check_mark: | :heavy_check_mark: |
mineral | :heavy_check_mark: | :heavy_check_mark: |
Nuke | :heavy_check_mark: | :heavy_check_mark: |
PowerCreep | :heavy_check_mark: | :heavy_check_mark: |
Resource | :heavy_check_mark: | :heavy_check_mark: |
Ruin | :heavy_check_mark: | :heavy_check_mark: |
Source | :heavy_check_mark: | :heavy_check_mark: |
Container | :heavy_check_mark: | :heavy_check_mark: |
Controller | :heavy_check_mark: | :heavy_check_mark: |
Extension | :heavy_check_mark: | :heavy_check_mark: |
Extractor | :heavy_check_mark: | :heavy_check_mark: |
Factory | :heavy_check_mark: | :heavy_check_mark: |
InvaderCore | :heavy_check_mark: | :heavy_check_mark: |
Keeper Lair | :heavy_check_mark: | :heavy_check_mark: |
Lab | :heavy_check_mark: | :heavy_check_mark: |
Link | :heavy_check_mark: | :heavy_check_mark: |
Nuker | :heavy_check_mark: | :heavy_check_mark: |
Observer | :heavy_check_mark: | :heavy_check_mark: |
Power Bank | :heavy_check_mark: | :heavy_check_mark: |
Power Spawn | :heavy_check_mark: | :heavy_check_mark: |
Portal | :heavy_check_mark: | :heavy_check_mark: |
Rampart | :heavy_check_mark: | :heavy_check_mark: |
Road | :heavy_check_mark: | :heavy_check_mark: |
Spawn | :heavy_check_mark: | :heavy_check_mark: |
Storage | :heavy_check_mark: | :heavy_check_mark: |
Terminal | :heavy_check_mark: | :heavy_check_mark: |
Tower | :heavy_check_mark: | :heavy_check_mark: |
Wall | :heavy_check_mark: | :heavy_check_mark: |
Tombstone | :heavy_check_mark: | :heavy_check_mark: |
Warp Container | :white_check_mark: |