https://github.com/troygoode/screeps-remote-example
https://github.com/troygoode/screeps-remote-example
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/troygoode/screeps-remote-example
- Owner: troygoode
- License: mit
- Created: 2016-09-29T04:15:31.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-09-29T15:51:58.000Z (over 8 years ago)
- Last Synced: 2025-04-15T02:07:51.002Z (about 1 month ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 3
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# screeps-remote-example
A minimalist example of using the [screeps-remote](https://github.com/overra/screeps-remote) development tool for [Screeps](https://screeps.com/).
## Notes
* This example looks to the `SCREEPS_USERNAME` and `SCREEPS_PASSWORD` environment variables for authentication details to avoid a situation where you commit secrets into git.
* To aid in the above, we use the [dotenv](https://www.npmjs.com/package/dotenv) library to automatically load the contents of the `.env` file (not present by default) in this folder into your environment variables at run-time.
* You must create the `.env` file yourself. An example is provided below.
* The `.gitignore` has been configured to ensure that `.env` does not get committed to git.
## Example `.env` File
```
SCREEPS_USERNAME=your_username_here
SCREEPS_PASSWORD=your_password_here
```