Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/solaris-games/solaris

A HTML5 game of strategy, intrigue and galactic conquest.
https://github.com/solaris-games/solaris

4x 4x-strategy-game games hacktoberfest strategy

Last synced: 3 months ago
JSON representation

A HTML5 game of strategy, intrigue and galactic conquest.

Host: GitHub
URL: https://github.com/solaris-games/solaris
Owner: solaris-games
License: gpl-3.0
Created: 2019-09-14T10:50:24.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-10-29T19:20:44.000Z (3 months ago)
Last Synced: 2024-10-29T20:26:25.952Z (3 months ago)
Topics: 4x, 4x-strategy-game, games, hacktoberfest, strategy
Language: TypeScript
Homepage: https://solaris.games
Size: 41.9 MB
Stars: 184
Watchers: 10
Forks: 65
Open Issues: 182
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

# Solaris

Solaris is a slow-burn browser game heavily inspired by [Neptune's Pride](https://np.ironhelmet.com) and [Subterfuge](http://subterfuge-game.com/).

![](client/src/assets/screenshots/game1.png)

- Build economic, industrial and scientific infrastructure to improve your empire.
- Build carriers to travel to new stars or to fight your enemies.
- Research new technologies to gain an edge over your opponents.
- Hire specialists which grant special abilities to stars and carriers like increased weapons and speed.
- Set up trade with your allies to get ahead of the curve.
- Play games with up to 32 players at a time.
- Participate in group chats with your allies to discuss strategy.
- Fight other players and capture stars to win the game.
- Games last around 2-3 weeks, and you don't need to commit a lot of time to play!
- Play on any device that has a web browser.
- Its completely free!

Visit [solaris.games](https://solaris.games) to play now!

### Server
The server uses the following tech:
- [Node.js](https://nodejs.org/en/)
- [Express](https://expressjs.com/)
- [MongoDB](https://www.mongodb.com/)
- [Mongoose](https://mongoosejs.com/)

### Client
The client uses the following tech:
- [Vue.js](https://vuejs.org/)
- [PixiJS](https://www.pixijs.com/)

## Development Environment Setup
1. Install the prerequisites.
- [Node.js](https://nodejs.org/en/) v20
- [MongoDB](https://www.mongodb.com/) v5.0
2. Clone the repository.
3. Checkout `master`.
4. `npm install` in both `client/` and `server/` directories.
5. Create a `.env` file in `server/` (See `.env.example`).
6. Create a `.env` file in `client/` (See `.env.example`).
7. `npm run start-jobs:dev` in `server/` to start the automated jobs and setup new games.
8. `npm run start-api:dev` in `server/` to start the API.
9. `npm run serve` in `client/` to start the client application.
10. Browse to the site locally (default [http://localhost:8080](http://localhost:8080)).

*Note: Development work is to be based on the `dev` branch, for a new feature or bug fix, create a branch from `dev`.*

### Database Migrations
To keep up to date with the latest changes, you must run the database migations to ensure that your database is compatible.

1. `npm run start-db-migrate:dev` in `server/` to update your local database to the latest schema.

*Note: This script assumes that you have a `solaris` database on your system. If not, perform the **Development Environment Setup** above first.*

### Development Environment Automation (Optional)
To automate the development environment, it is recommended to use [PM2](https://pm2.keymetrics.io/).

1. Install `pm2`.
2. `pm2 start pm2.config.js` to register `pm2` apps.

The above script will create the server jobs, API and client applications, watch for changes and restart those applications when necessary.

You can make use of debugger attach for VS Code defined in the `.vscode/launch.json` configuration file to easily attach the debugger to running apps.

Once configured, you can browse to the site locally (default [http://localhost:8080](http://localhost:8080)) as using the normal way detailed in the section above and any changes you make will automatically restart the applications.

## Run with docker
1. Install [Docker](https://docs.docker.com/engine/install/).
2. Create a `.env` file in `server/` (See `.env.example`).
3. Create a `.env` file in `client/` (See `.env.example`).
4. Run `docker compose up` in the project folder
5. Browse to the site locally (default [http://localhost:8080](http://localhost:8080)).

## Contributing
See [here](CONTRIBUTING.md).

## License
See [here](LICENSE).