1. Welcome to the official Starbound Mod repository, Guest! Not sure how to install your mods? Check out the installation guide or check out the modding help thread for more guides.
    Outdated Mods have been moved to their own category! If you update your mod please let a moderator know so we can move it back to the active section.
    Dismiss Notice

Starbound Race Description Patcher - Compiler tool 1.0

A tool to make writing racial descriptions for your race mod easier.

  1. GTG3000
    Race description patcher-compiler is a pair of scripts, aimed to simplify the titanic task of writing racial descriptions for all the objects in the game, through two steps:

    First, crawler-retriever.py goes through the objects of the base game and generates a nice big json file with descriptions for you to edit.

    Second, after you've done editing, the patcher-dumper.py generates folders and .object.patch files that you can put directly into your mod.

    A step up from having to do that by hand!

    Currently requires python 3 to run. Any help to port it to something to be compiled into an executable would be welcome.


    1. Run crawler-retriever.py in the /objects folder, or in subfolder you wish to generate a listing for. Remember that the relative path in the generater .json depends on where the script was run, and determines where the resulting folders will need to be placed.
    2. Edit the generated namedump.json. The field that interests you is "desc". It will be filled by a copy of the default description. You can cut out entries however you like, but remember that it needs to be a valid json array, formatted like :

      [ { "desc" : "...", "file" : "...", "path" : "...", "name" : "..."}]

      Also, remember not to change file and path fields, as misplaced or misnamed patch file will not apply.
    3. After you're done editing, run the edited json file through the crawler-retriever.py script, as follows:

      python patcher-dumper.py filename.json racename

    4. The script will then generate folders you will have to place into your mods /objects folder (or a corresponding subfolder, depending on where retriever was run)
    Mod Pack Permissions:
    Anyone can use this mod in their mod compilation without the author's consent.
    Mod Assets Permissions:
    Anyone can alter/redistribute the mod's assets without the author's consent.
    TeamFirefly and DrPvtSkittles like this.

Recent Reviews

  1. IHart
    Version: 1.0
    This has saved me an indescribable amount of time. Have you listed in the credits of the project.