Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ScreepsMods/screepsmod-mongo
Replace LokiJS with MongoDB and Redis
https://github.com/ScreepsMods/screepsmod-mongo
hacktoberfest mod mongo redis screeps screeps-modules screepsmod
Last synced: 11 days ago
JSON representation
Replace LokiJS with MongoDB and Redis
- Host: GitHub
- URL: https://github.com/ScreepsMods/screepsmod-mongo
- Owner: ScreepsMods
- License: mit
- Created: 2017-07-25T13:30:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-02T22:43:02.000Z (about 1 year ago)
- Last Synced: 2024-04-15T08:10:44.394Z (7 months ago)
- Topics: hacktoberfest, mod, mongo, redis, screeps, screeps-modules, screepsmod
- Language: JavaScript
- Homepage:
- Size: 1.06 MB
- Stars: 25
- Watchers: 4
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# screepsmod-mongo
## MongoDB And Redis for the Screeps Private Server
[](https://standardjs.com)
[](https://circleci.com/gh/ScreepsMods/screepsmod-mongo/tree/master)
## Requirements
* screeps 4.0+
* mongodb 2.6+
* redis 3.0.6+ For Windows installs, you can follow these steps: https://github.com/ServiceStack/redis-windows#option-3-running-microsofts-native-port-of-redis
## Installation
Installing on Ubuntu? Check out the community guide in the official Docs [Private server on Ubuntu using MongoDB and Redis](http://docs.screeps.com/contributed/ps_ubuntu.html) or the newer screeps-launcher guide [Newbie-friendly (ish) private/dedicated server setup guide for Ubuntu 18.04, with automatic startup](https://www.reddit.com/r/screeps/comments/deyq66/newbiefriendly_ish_privatededicated_server_setup/)
1. Ensure both mongodb and redis are already installed and running
2. `npm install screepsmod-mongo` inside your server's mods folder
3. Ensure the mod has been added to mods.json. Eg:
```
"mods": [
"node_modules\\screepsmod-mongo\\index.js"
],
```
4. Start server!
5. DB Population
* `mongo.importDB()` in the screeps cli imports your existing DB
OR
* `system.resetAllData()` in the screeps cli for a completely fresh DB
6. Once done restart the server
7. Done!
## Usage
With this mod installed you can continue to manage the server as usual,
all CLI commands behave identically.
The original storage module will still run, but is completely ignored.
Keep in mind that RAM requirements are slightly higher, by default mongo
uses 50% - 1G of your system RAM. Redis on the other hand, uses very little.
Mongo and Redis CLIs can be used to see and modify the data as usual,
backups and restores should be done via normal mongo and redis tools.
https://docs.mongodb.com/manual/tutorial/backup-and-restore-tools/
https://redis.io/topics/persistence
## Configuration
All options and defaults are listed below
### Mongo
* host: localhost
* port: 27017
* database: screeps
* uri: mongodb://localhost:27017/screeps
If the uri Parameter is supplied it will overwrite all other settings. Use it for Authentication, passing extra options, etc.
### Redis
* host: localhost
* port: 6379
## Examples
Config can be applied in several ways:
### .screepsrc (Recommended)
Add to the bottom of your .screepsrc file
```
[mongo]
host = 192.168.0.222
[redis]
host = 192.168.0.222
```
### ENV Method
Please note that this method only works when launching modules directly, when launched via the default launcher they will be ignored.
```
MONGO_HOST='192.168.0.222'
MONGO_CONN='mongodb://username:[email protected]/database_name?ssl=true'
```