https://github.com/cryptiklemur/screeps-ts
https://github.com/cryptiklemur/screeps-ts
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/cryptiklemur/screeps-ts
- Owner: cryptiklemur
- License: unlicense
- Created: 2020-08-13T20:47:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-15T20:45:46.000Z (almost 6 years ago)
- Last Synced: 2025-02-01T15:45:18.618Z (over 1 year ago)
- Language: TypeScript
- Size: 139 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Screeps
## Basic Usage
You will need:
- [Node.JS](https://nodejs.org/en/download) (10.x)
- A Package Manager ([Yarn](https://yarnpkg.com/en/docs/getting-started) or [npm](https://docs.npmjs.com/getting-started/installing-node))
- Rollup CLI (Optional, install via `npm install -g rollup`)
Download the latest source [here](https://github.com/screepers/screeps-typescript-starter/archive/master.zip) and extract it to a folder.
Open the folder in your terminal and run your package manager to install the required packages and TypeScript declaration files:
```bash
# npm
npm install
# yarn
yarn
```
Fire up your preferred editor with typescript installed and you are good to go!
### Rollup and code upload
This project uses rollup to compile your typescript and upload it to a screeps server.
Move or copy `screeps.sample.json` to `screeps.json` and edit it, changing the credentials and optionally adding or removing some of the destinations.
Running `rollup -c` will compile your code and do a "dry run", preparing the code for upload but not actually pushing it. Running `rollup -c --environment DEST:main` will compile your code, and then upload it to a screeps server using the `main` config from `screeps.json`.
You can use `-cw` instead of `-c` to automatically re-run when your source code changes - for example, `rollup -cw --environment DEST:main` will automatically upload your code to the `main` configuration every time your code is changed.
Finally, there are also NPM scripts that serve as aliases for these commands in `package.json` for IDE integration. Running `npm run push-main` is equivalent to `rollup -c --environment DEST:main`, and `npm run watch-sim` is equivalent to `rollup -cw --dest sim`.
#### Important! To upload code to a private server, you must have [screepsmod-auth](https://github.com/ScreepsMods/screepsmod-auth) installed and configured!
## Typings
The type definitions for Screeps come from [typed-screeps](https://github.com/screepers/typed-screeps). If you find a problem or have a suggestion, please open an issue there.
## Contributing
Issues, Pull Requests, and contribution to the docs are welcome! See our [Contributing Guidelines](CONTRIBUTING.md) for more details.