TradeWars / Economy

Other
0 stars 0 forks source link

Economy

Codacy Badge codecov

master Build Status for master branch
staging Build Status for staging branch
develop Build Status for develop branch

Usage

TODO

How to interface with the service, either via Pawn or, if the service does not directly communicate with the gamemode, whatever interface is provided.

Deployment

TODO

Contributing

Please read the contribution guidelines

Tests

All Kotlin-specific tests reside inside of src/test/kotlin. You can run the tests with the following command:

./gradlew test

If you need an example, take a look at src/test/kotlin/org/tradewars/economy/ExampleTest.kt.

Writing new tests

When writing new tests, those should possibly reside in the same package as the tested classes.

For example:

└── src
    ├── main
    │   └── kotlin
    │       └── com
    │           └── example
    │               └── structure
    │                   └── for
    │                       └── unit
    │                           └── tests
    │                               └── NuclearWeapon.kt
    └── test
        └── kotlin
            └── com
                └── example
                    └── structure
                        └── for
                            └── unit
                                └── tests
                                    └── NuclearWeaponTest.kt

Build

In order to build the Economy module as a standalone file, run:

./gradlew shadowJar

This will create the file /build/libs/Economy.jar. The shadowJar task runs the test task automatically.