|
Post by Brownie on Oct 28, 2024 16:18:26 GMT -5
I am currently working on describing all of the text files in Clangen and how to properly edit them. This will be a fairly big project for me and will not be completed any time soon, but I hope to have a general description of every line and variable for Clans, cats, and injuries by the end of november.
NOTE! This thread will only cover file editing and personal game modding for the BASE GAME CLANGEN download for windows or mac. You cannot do any file editing on the web application. This tutorial will not cover any python code edits to the game, or UI edits. Only text additions, modifications, or removals will be covered.
If you install mods, datapacks, or skinpacks, you will need to consult the readme and resources given on their fork for any bugfixes or edits. Please be careful and responsible with open-file game modding and only participate in these features if you understand how they modify your game and how to properly install them.
|
|
|
Post by Brownie on Oct 28, 2024 16:18:42 GMT -5
CLAN DETAILS Includes: Changing Clan name, changing leader, making multiple leaders, changing leader's lives, changing territories, editing border Clans, editing wars. Navigate to the roaming save file -> Saves Each Clan will have a FOLDER and a .JSON In this part, we'll cover all the variables in the .JSON Open and edit this in notepad, wordpad, or a similar BASIC text editor. I do NOT recommend using microsoft or adobe applications (word, pdf modifiers) as they will ruin the formatting and Clangen will not be able to read the file. Alternatively, you can use IDE's (visual studio, jupyter ect) but if you're more comfortable working in those than notepad, you probably don't need me to tell you how to edit a .json Always hit "save" not "save as" when making changes to any Clangen file! You want to overwrite what is there, not make a new copy. Punctuation marks (commas, colons) should always go OUTSIDE the quotation marks " " of a string (ex: "clanname": "Brook",) When you open a Clan's file, it should look something like this! { "clanname": "Brook", "clanage": 8, "biome": "Plains", "camp_bg": "camp1", "gamemode": "expanded", "instructor": "47", "reputation": 90, "mediated": [], "starting_season": "Newleaf", "temperament": "stoic", "version_name": 3, "version_commit": "v0.11.2", "source_build": false, "leader": "42", "leader_lives": 0, "leader_predecessors": 0, "deputy": "42", "deputy_predecessors": 0, "med_cat": "45", "med_cat_number": 0, "med_cat_predecessors": 0, "clan_cats": "42,42,45,47,46,25,32,33,39,41,43,44,1,2,3,4,5,6,7,8", "faded_cats": "", "patrolled_cats": [], "other_clans_names": "Lavender", "other_clans_relations": "10", "other_clan_temperament": "mellow", "war": { "at_war": false, "enemy": null, "duration": 0 } } I'm going to go through every argument one by one and tell you exactly what it does, how to correctly format changes to it, and what inputs are valid for each field. "clanname": "Brook", WHAT: Pretty easy, this is your Clan's name! HOW: If you'd like to change your Clan's name, you must change three things: this field in the .json, the file name of the .json, and the file name of the accompanying Clan folder. ALL THREE MUST BE CHANGED TO THE SAME NAME OR YOU WILL NOT BE ABLE TO LOAD THE FILE. VALID: Do note that Clangen will always automatically append -Clan, so only put the prefix here. You CANNOT have two Clans with the same name, so if you make many Clans, check the list in your saves before you change this. I don't know what the game will do, but it can possibly eat one or both of your saves, so double check your name change is unique before you make the change. FORMAT: The prefix must be in quotation marks " " -- this is a text string. (ex. "Ghost") "clanage": 8, WHAT: This is the the number of moons displayed in game. HOW: Change the number to whatever you want. This is a cosmetic change and does not affect gameplay at all. VALID: Any digit, even negative numbers. Go wild. (Note that the game will not generate events or relationships when the counter reaches 0 if you start at a negative value) FORMAT: A positive digit with no markers. (ex. 4) "biome": "Plains", WHAT: This is the biome you chose when you made your Clan. There are currently four biomes: Plains, mountains, forest and beach. Each biome has their own unique patrols and events. Some biomes are more dangerous than others. Some biomes have less prey than others. Some biomes have harder patrol checks than others. Forest is the most forgiving, then plains in the middle, and beach and mountains are considered difficult territory types. VALID: "Plains" "Mountainous" "Forest" "Beach" FORMAT: quotation marks "camp_bg": "camp1", WHAT: This is the background image of your Clan. It is purely cosmetic and has no in-game effect. VALID: "camp1" "camp2" "camp3" and for FOREST ONLY "camp4" FORMAT: lowercase, in quotations, with a number and no space. (ex: "camp3") Biome/camp | Forest | Mountain | Plains | Beach | "camp1" | Classic | Cliff | Grasslands | Tidepools | "camp2" | Gully | Cavern | Tunnels | Tidal Cave | "camp3" | Grotto | Crystal river | Wastelands | Shipwreck | "camp4" | Lakeside | - | - | - |
"gamemode": "expanded", WHAT: Clangen has two gamemodes: Classic and Expanded. In Classic, cats cannot be sick; fights result in death or scars only. The game also does not track herbs or prey. Classic is meant for a storytelling experience, while the extra mechanics in expanded allow for harder gameplay challenges. VALID: "classic" "expanded" FORMAT: quotation marks NOTES: You will not have any prey when moving from Classic -> Expanded, and so you must edit those in else your cats will instantly starve and die on the next turn. If moving from Expanded -> Classic, any cats that are in the healer's den will be permanently injured/ill and unable to patrol until their conditions are manually removed. "instructor": "47", WHAT: This is the cat ID of your StarClan guide. VALID: a cat ID from that Clan's folder -> Clan_cats.json FORMAT: quotation marks NOTES: You technically can make your StarClan guide a living cat. All mechanics for a StarClan guide are preserved, including your guide leading followers to the DF if they are exiled there (because they are living, you must file-edit them to the DF and cannot use in-game buttons, but it is possible!) "reputation": 90, WHAT: This is your reputation with outsiders. The higher the number, the more likely your Clan will encounter loners and kittypets that want to join your Clan. VALID: Default values are 0-100 FORMAT: quotation marks "mediated": [], WHAT: This line keeps track of which mediators have worked each moon. VALID: a cat ID FORMAT: new line indented, quotation marks (see above formatting guide for indents) "starting_season": "Newleaf", WHAT: This is the season at moon 0. The season of all moons is calculated from this. VALID: "Newleaf" "Greenleaf" "Leaf-fall" "Leaf-bare" (don't ask why two are hyphenated and two aren't!!! I don't make the rules!!) FORMAT: One of the above four as typed, quotation marks "temperament": "stoic", WHAT: This is your Clan's personality.
|
|
|
Post by Brownie on Oct 28, 2024 16:18:54 GMT -5
CAT EDITING Includes: Changing cats names, family trees, sprite design, bring cats back to life, bring them back to the Clan (or exiling), Add or remove cats from the file entirely, change their skills, personality and experience, give accessories and more.
Navigate to the roaming save file -> Saves Each Clan will have a FOLDER and a .JSON Navigate to the Clan's folder, then open the clan_cats.json
Open and edit this in notepad, wordpad, or a similar BASIC text editor. I do NOT recommend using microsoft or adobe applications (word, pdf modifiers) as they will ruin the formatting and Clangen will not be able to read the file. Alternatively, you can use IDE's (visual studio, jupyter ect) but if you're more comfortable working in those than notepad, you probably don't need me to tell you how to edit a .json
Always hit "save" not "save as" when making changes to any Clangen file! You want to overwrite what is there, not make a new copy.
Punctuation marks (commas, colons) should always go OUTSIDE the quotation marks " " of a string (ex: "clanname": "Brook",)
Each cat should look something like this!
{ "ID": "49", "name_prefix": "Ice", "name_suffix": "path", "specsuffix_hidden": false, "gender": "female", "gender_align": "female", "birth_cooldown": 0, "status": "medicine cat", "backstory": "clan_founder", "moons": 77, "trait": "thoughtful", "facets": "11,10,2,11", "parent1": null, "parent2": null, "adoptive_parents": [], "mentor": null, "former_mentor": [], "patrol_with_mentor": 0, "mate": [], "previous_mates": [], "dead": true, "paralyzed": false, "no_kits": false, "no_retire": false, "no_mates": false, "exiled": false, "pelt_name": "Smoke", "pelt_color": "SILVER", "pelt_length": "long", "sprite_kitten": 1, "sprite_adolescent": 5, "sprite_adult": 9, "sprite_senior": 13, "sprite_para_adult": 15, "eye_colour": "BLUE", "eye_colour2": null, "reverse": false, "white_patches": null, "vitiligo": null, "points": null, "white_patches_tint": "none", "pattern": null, "tortie_base": null, "tortie_color": null, "tortie_pattern": null, "skin": "DARKGREY", "tint": "pink", "skill_dict": { "primary": "STORY,23,False", "secondary": "FIGHTER,7,False", "hidden": null }, "scars": [], "accessory": "BLUE FEATHERS", "experience": 295, "dead_moons": 68, "current_apprentice": [], "former_apprentices": [ "54" ], "df": false, "outside": false, "faded_offspring": [], "opacity": 100, "prevent_fading": false, "favourite": false },
Again, I'm going to go through line-by-line and discuss what everything means and how to format valid inputs.
"ID": "49", WHAT: This is a cat's ID number. Any time a cat is called by another file, it needs the ID number. HOW: DO NOT CHANGE THIS VALUE. NOTE: This is important to reference, but if you alter a cat's ID, that cat will no longer load.
"name_prefix": "Ice", WHAT: This is the first half of a cat's name, or the full name of an outsider HOW: Put whatever you want in there! FORMAT: Quotation marks
"name_suffix": "path", WHAT: This is the second half of a cat's name. Leave it blank (just quotation marks with nothing inside) for outsiders. HOW: Put anything here! FORMAT: Quotation marks (must leave quotation marks with nothing inside for a blank suffix)
"specsuffix_hidden": false, WHAT: This is the command that overrides the suffix with a role suffix (star, paw, kit) HOW: if false, a warrior suffix will be shown. if true, a cat will obtain a suffix for their rank (leader, apprentice, kit) VALID: true or false. FORMAT: no formatting
"gender": "female", WHAT: This is the line that designates if a cat can be pregnant or sire kittens. HOW: This gender is not shown, and is only marked internally so the game can properly do Clan propagation when the "pregnancy ignores biology" setting is off. There are no mechanics for intersex or XXY males in Clangen: a cat can only ever be male or female. VALID: "male" "female" FORMAT: quotation marks
"gender_align": "female", WHAT: This is the gender that is shown in-game. HOW: You can put any gender orientation you'd like in here! By default, the only genders Clangen can create are "male" "female" "trans male" "trans female" and "nonbinary" but you may enter any orientation in the code or in the game under "custom gender". A cat's gender orientation has no in game functionality and is only there for flavor. VALID: Any string. FORMAT: Quotation marks
"birth_cooldown": 0, WHAT: This is the number of moons until a queen can have another litter. Once a litter is born, this number is set to 6 and counts down one each moon. If it is 0, a queen can become pregnant again. HOW: Remember, this is only the CHANCE to become pregnant; a number of 0 does not mean your cat will have kits at the first opportunity. Most cats will sit at 0. If you'd like your cats to be unable to have kits for a set amount of time, you can use this cooldown to put a timer on, so to speak. VALID: Any positive number. FORMAT: none
"status": "medicine cat", WHAT: This is your cat's rank in the Clan. HOW: If you want to have multiple leaders, you will also have to edit the Clan's .json file. There is a separate tutorial in the misc tutorials below showing which lines you must change in both files to correctly add a second leader. VALID: "leader" "deputy" "medicine cat" "mediator" "apprentice" "warrior" "elder" FORMAT: quotation marks
|
|
|
Post by Brownie on Oct 28, 2024 16:19:11 GMT -5
save 2 for Clan cat editing (aka adding new cats to the game from scratch, complex family tree edits)
|
|
|
Post by Brownie on Oct 28, 2024 16:19:30 GMT -5
save for injuries, illnesses and conditions
|
|
|
Post by Brownie on Oct 28, 2024 16:19:47 GMT -5
save for patrols
|
|
|
Post by Brownie on Oct 28, 2024 16:20:01 GMT -5
save for events
|
|
|
Post by Brownie on Oct 28, 2024 16:20:14 GMT -5
save for relationships
|
|
|
Post by Brownie on Oct 28, 2024 16:21:14 GMT -5
save for personality traits, facets, training, mentorship
|
|
|
Post by Brownie on Oct 28, 2024 16:21:52 GMT -5
save for backstories, text replacement, ceremonies
|
|
|
Post by Brownie on Oct 28, 2024 16:22:05 GMT -5
save for misc dict editing
|
|
|
Post by Brownie on Oct 28, 2024 16:22:18 GMT -5
save for misc data editing
|
|
|
Post by Brownie on Oct 28, 2024 16:23:24 GMT -5
general collection of tutorials, as well as how to properly mod, skinmod, and backup files
|
|
|
Post by Brownie on Oct 28, 2024 16:23:39 GMT -5
+ 1 for skinning
|
|
|
Post by Brownie on Oct 28, 2024 16:23:50 GMT -5
and two extras...
|
|
|
Post by Brownie on Oct 28, 2024 16:24:21 GMT -5
I make these in separate posts so that I can use the top directory to link straight to that section, like chapters. Keeps things easy to find and navigate. Also easier to edit
|
|
|
Post by Brownie on Oct 28, 2024 16:24:58 GMT -5
okay, that'll be enough saves for the sections I plan to include. Hopefully that'll be enough. I'll have the gen Clan page and cats up very soon, along with their resources and good databases
|
|