Scyye/ROUNDS.py

A framework for creating stat card mods for the game ROUNDS by Landfall in python.

ROUNDS.py V1.0.0

By Scyye

Description

A framework for creating stat card mods for the game ROUNDS in python.

More features coming soon, this is just the first release to get the ball rolling.

How to use

run git clone https://github.com/Scyye/ROUNDS.py and create a .py file in the directory it cloned to

Make sure you have python installed, as well as dotnet 6.0

Then, create a new python file and import the package:

from ROUNDS.mod import Mod

Example

To initialise your mod:

from ROUNDS import Mod

# NOTE: Version must be in the format of "x.x.x" where x is any number (can be multiple digits)
mod = Mod(name="Your Mod Name", author="Your Name", description="Describe your mod", version="1.0.0")

To add a stat card:

from ROUNDS import InfoStat, Stat

# NOTE: You can add as many cards as you want
mod.add_card(name="Name", description="What does your card do?", stats=[
    InfoStat(stat=Stat.Health, value=1.5, positive=True), # Health is multiplied by 1.5
    InfoStat(stat=Stat.Damage, value=0.5, positive=False), # Damage is multiplied by 0.5
    InfoStat(stat=Stat.Ammo, value=2, positive=True) # Ammo is incremented (increased) by 2
])

Then, to save your mod:

mod.build()

This will then create a folder called build in the same directory as your python file. Inside will be a zip file with the name of your mod, and inside that will all the files your mod needs in order to be uploaded to thunderstore following this guide.

Publishing & Testing

To test your mod, simply build it as shown above, then go to Thunderstore or r2modman, go to settings -> import local mod and select the zip file.

Once you verify that it works, you can upload it to Thunderstore following the guide above.

Bug Reports

If you find any bugs, or have any questions, either open an issue on the github repo or join the ROUNDS Modding Discord and ping me (@scyye) in #mod-bug-chat.