WoW WOTLK Classic Simulator

https://github.com/wowsims/wotlk
Admin
A DPS simulator framework for World of Warcraft WOTLK Classic providing accurate damage simulations...
Tokens:3,560
Snippets:53
Trust Score:8.3
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Setup Project Dependencies

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Installs project dependencies and sets up the development environment. This command also installs `air` for automatic hot-reloading of dev servers.

```bash
make setup
```

--------------------------------

### Install Go, Protobuf, and Node on Ubuntu

Source: https://github.com/wowsims/wotlk/blob/master/README.md

This script installs Go, protobuf compiler, and Node.js using nvm. Ensure you are in the 'wotlk' directory before running.

```shell
# Standard Go installation script
curl -O https://dl.google.com/go/go1.21.1.linux-amd64.tar.gz
sudo rm -rf /usr/local/go 
sudo tar -C /usr/local -xzf go1.21.1.linux-amd64.tar.gz
echo 'export PATH=$PATH:/usr/local/go/bin' >> $HOME/.bashrc
echo 'export GOPATH=$HOME/go' >> $HOME/.bashrc
echo 'export PATH=$PATH:$GOPATH/bin' >> $HOME/.bashrc
source $HOME/.bashrc

cd wotlk

# Install protobuf compiler and Go plugins
sudo apt update && sudo apt upgrade
sudo apt install protobuf-compiler
go get -u -v google.golang.org/protobuf
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest

# Install node
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
nvm install 19.8.0

# Install the npm package dependencies using node
npm install
```

--------------------------------

### Docker Development Workflow for WOTLK Sim

Source: https://github.com/wowsims/wotlk/blob/master/README.md

This section outlines the Docker setup for local development. It includes building the image, installing dependencies, and running commands within the container.

```shell
git clone https://github.com/wowsims/wotlk.git
cd wotlk

# Build the docker image and install npm dependencies (only need to run these once).
docker build --tag wowsims-wotlk .
docker run --rm -v $(pwd):/wotlk wowsims-wotlk npm install

# Now you can run the commands as shown in the Commands sections, preceding everything with, "docker run --rm -it -p 8080:8080 -v $(pwd):/wotlk wowsims-wotlk".
# For convenience, set this as an environment variable:
WOTLK_CMD="docker run --rm -it -p 8080:8080 -v $(pwd):/wotlk wowsims-wotlk"

# ... do some coding on the sim ...

# Run tests
$(echo $WOTLK_CMD) make test

# ... do some coding on the UI ...

# Host a local site
$(echo $WOTLK_CMD) make host
```

--------------------------------

### Install protoc-gen-jsonschema

Source: https://github.com/wowsims/wotlk/blob/master/tools/APL.md

Installs the protoc-gen-jsonschema plugin, which is used to generate JSON schemas from Protocol Buffers definitions.

```bash
go install github.com/chrusty/protoc-gen-jsonschema/cmd/protoc-gen-jsonschema@latest
```

--------------------------------

### Host Local UI with Full Client Rebuild

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Launches a local UI server at http://localhost:8080. It recompiles the entire client using `make dist/wotlk` before starting. Visit your custom spec at http://localhost:8080/wotlk/YOUR_SPEC_HERE.

```bash
make host
```

--------------------------------

### Run Development Server with File Watching

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Starts the development server with file watching enabled. The server automatically restarts and recompiles on Go or TypeScript changes.

```bash
WATCH=1 make rundevserver
```

--------------------------------

### Host Local UI with File Watching

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Starts the local UI server with file watching enabled. Changes in Go or TypeScript files will automatically restart the server and recompile the client.

```bash
WATCH=1 make host
```

--------------------------------

### Install Pre-commit Git Hook for Go Code Formatting

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Installs a pre-commit git hook to automatically format Go code. Manual formatting can be done using 'make fmt'.

```shell
# Installs a pre-commit git hook so that your go code is automatically formatted (if you don't use an IDE that supports that).  If you want to manually format go code you can run make fmt.
```

--------------------------------

### Example Pre-pull Action

Source: https://github.com/wowsims/wotlk/blob/master/tools/APL.md

An example of a pre-pull action in APL, which schedules a spell to be cast at a specific time before combat begins.

```json
{
    "action": {
        "castSpell": {
            "spellId": {
                "spellId": 1
            }
        }
    },
    "doAt": "-1s"
}
```

--------------------------------

### Elemental Shaman Priority List Condition

Source: https://github.com/wowsims/wotlk/blob/master/tools/APL.md

An example APL priority list action for Elemental Shaman. It checks if the Flame Shock DoT is applied before casting Lava Burst, ensuring the DoT is active.

```json
{
    "action": {
        "condition": {
            "cmp": {
                "op": "OpGt",
                "lhs": {
                    "dotRemainingTime": {
                        "spellId": {
                            "spellId": 49233
                        }
                    }
                },
                "rhs": {
                    "spellCastTime": {
                        "spellId": {
                            "spellId": 60043
                        }
                    }
                }
            }
        },
        "castSpell": {
            "spellId": {
                "spellId": 60043
            }
        }
    }
}
```

--------------------------------

### Host Client from Filesystem with Wowsimwotlk Binary

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Runs the `wowsimwotlk` binary using the `--usefs` flag to host the client directly from the /dist directory. This requires the binary to be built first (e.g., via `make devserver`).

```bash
./wowsimwotlk --usefs
```

--------------------------------

### Build and Host the Sim UI

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Commands to build the simulation UI and host it locally for testing. Navigate to http://localhost:8080/wotlk/$SPEC after running.

```bash
make host

```

--------------------------------

### Build Native Wowsimwotlk Binary

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Creates the `wowsimwotlk` binary, which can host the UI and run simulations natively. It builds the UI and embeds it into the binary, allowing the sim to be hosted as a server instead of using WASM on the client.

```bash
make wowsimwotlk
```

--------------------------------

### Run Development Server for Core Go Code

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Recompiles the `wowsimwotlk` server binary and runs it, hosting the /dist directory at http://localhost:3333/wotlk. This is the fastest way to iterate on core Go simulator code without client rebuilds.

```bash
make rundevserver
```

--------------------------------

### Run Backend Tests

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Executes all available tests, primarily for the backend simulation. Ensure tests are up-to-date before running.

```bash
make test
```

--------------------------------

### Run Unit Tests

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Command to execute all unit tests for the simulation code. Ensure tests are written for new implementations.

```bash
make test

```

--------------------------------

### Enable Tooltip Color Links

Source: https://github.com/wowsims/wotlk/blob/master/ui/index_template.html

Enables color linking for tooltips within the WoWSims interface. This is a simple configuration object.

```javascript
const whTooltips = { colorLinks: true };
```

--------------------------------

### Generate Protocol Buffer Code

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Generates Go and TypeScript code from .proto files for communication between the simulation and the UI. This is automatically run by `make` after modifying proto files.

```bash
make
```

--------------------------------

### Initialize Google Analytics

Source: https://github.com/wowsims/wotlk/blob/master/ui/index_template.html

Initializes the Google Analytics data layer and configures the tracker. This code should be included in the head of your HTML document.

```html
window.dataLayer = window.dataLayer || [];
function gtag() {
  dataLayer.push(arguments);
}
gtag('js', new Date());
gtag('config', 'G-YEJ8MEHGV2');
```

--------------------------------

### Empty APL Rotation Structure

Source: https://github.com/wowsims/wotlk/blob/master/tools/APL.md

Defines the basic structure for an empty APL rotation file. This includes type, prepull actions, and the priority list.

```json
{
    "type": "TypeAPL",
    "prepullActions": [],
    "priorityList": []
}
```

--------------------------------

### Clean Generated Files

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Removes all generated files, including protocol buffer outputs (.pb.go, .ts) and the distribution directory (dist/).

```bash
make clean
```

--------------------------------

### Generate APL JSON Schema

Source: https://github.com/wowsims/wotlk/blob/master/tools/APL.md

Generates a JSON schema for APL files from a proto definition. This schema enables autocompletion and validation in VS Code.

```bash
mkdir jsonschema

protoc \
--jsonschema_out=./jsonschema \
--proto_path=./proto/ \
--jsonschema_opt=json_fieldnames \
--jsonschema_opt=enforce_oneof \
--jsonschema_opt=disallow_additional_properties \
./proto/apl.proto
```

--------------------------------

### Recompile UI for a Specific Spec

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Recompiles only the TypeScript UI for a specified class/spec (e.g., elemental shaman).

```bash
make host_$spec
```

--------------------------------

### Generate Item Code

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Generates code related to items. This command is only necessary if changes have been made to the item generation logic.

```bash
make items
```

--------------------------------

### Update Expected Test Results

Source: https://github.com/wowsims/wotlk/blob/master/README.md

Updates the baseline for test results. This command must be run after adding/removing tests or when code changes affect test outcomes.

```bash
make update-tests
```
Tokens:
Raw