Difference between revisions of "Gaining familiarity with mods on KeeperRL"

From KeeperRL Wiki
Jump to: navigation, search
m (→‎Modding tutorial for KeeperRL)
m (→‎Modding tutorial for KeeperRL (Overview))
 
(40 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
==Modding tutorial for KeeperRL==
+
==Modding tutorial for KeeperRL (Overview) ==
 
*The first recommendation is to get familiar with the existing modding system on KeeperRL
 
*The first recommendation is to get familiar with the existing modding system on KeeperRL
−
*There are two types of mod on KeeperRL
+
*There are two types of mods on KeeperRL
−
**Local mods (Edit the [[Offical_Game_Files | official game files]] locally) - Can't be uploaded onto the Web. Easier to learn for beginners.
+
**Local mods (Edit the [[Official_Game_Configs | official game files]] locally) - Can't be uploaded onto the Web. Easier to learn for beginners.
−
**Web mods (Write new mod files that modify, replace or append to the official game files)
+
**Web mods (Write new mod files that modify, replace or append to the official game files) - Slightly tougher but you can upload them for other players to use.
 
*Make some simple changes to the vanilla files, that is the official files (Try some of the suggestions below) and test the changes. Vanilla configs are found under "KeeperRL\datafree\gamedata\*.txt"
 
*Make some simple changes to the vanilla files, that is the official files (Try some of the suggestions below) and test the changes. Vanilla configs are found under "KeeperRL\datafree\gamedata\*.txt"
−
  Note, when changing vanilla configs you need to back them up in case you damage them
+
  Note, when changing vanilla configs you need to back them up in case you damage them.
 +
If the worst happens, delete KeeperRL and reinstall it.
 
*After learning to do local mods, install some existing Web Mods
 
*After learning to do local mods, install some existing Web Mods
 
*Test them
 
*Test them
Line 11: Line 12:
  
 
==Suggestions for simple changes to workshops_menu.txt==
 
==Suggestions for simple changes to workshops_menu.txt==
−
Locate workshops_menu.txt. It should look like [[Workshops_Menu.txt|this linked file, which is a bit out of date but basically similar]].
+
Locate workshops_menu.txt. It should look like [https://github.com/miki151/keeperrl/blob/master/data_free/game_config/workshops_menu.txt this linked file, which is found in the vanilla configs folder].
  
 
===Remove wooden staffs from the workshop===
 
===Remove wooden staffs from the workshop===
Line 17: Line 18:
 
  WoodenStaff
 
  WoodenStaff
 
under the  
 
under the  
−
  # Workshop
+
  "basic"
 +
{
 +
  "WORKSHOP"
 
section.
 
section.
  
Line 23: Line 26:
 
In the line containing
 
In the line containing
 
  GoldenStaff
 
  GoldenStaff
−
on the
+
under the
−
  "# Forge"
+
  "basic" section under the
−
section change the numbers in that line.
+
  "FORGE" subsection
 +
change the numbers in that line.
  
 
===Sell rings of invisibility instead of wakefulness===
 
===Sell rings of invisibility instead of wakefulness===
 
Change the line containing
 
Change the line containing
−
  "RESTED"
+
  RESTED
 
in the
 
in the
−
  # Jeweller section.
+
  "JEWELER" subsection.
 
Change it to
 
Change it to
−
  "INVISIBLE"
+
  INVISIBLE
  
−
===Change an exchange rate for resources===
+
===Change the conversion exchange rate for resources===
 
In the
 
In the
−
  "# Lab section".
+
  "LABORATORY" section
−
experiment with changing the numbers.
+
experiment with changing the numbers (hint: look for the lines mentioning alchemical conversion).
  
 
==Suggestions for simple changes to technology.txt==
 
==Suggestions for simple changes to technology.txt==
−
Locate technology.txt. It should like like [[Technology.txt|this]]
+
Locate technology.txt. It should look like [https://github.com/miki151/keeperrl/blob/master/data_free/game_config/technology.txt this]
  
−
===Include a mention of heavy wooden clubs considering two-handed weapon tech===
+
===Include a mention of heavy wooden clubs for the two-handed weapon tech===
 
Change the line containing
 
Change the line containing
 
  two-handed weapons
 
  two-handed weapons
Line 50: Line 54:
 
===Remove the requirement for researching advanced sorcery before demonology===
 
===Remove the requirement for researching advanced sorcery before demonology===
 
Change the line containing:
 
Change the line containing:
−
  DEMONOLOGY
+
  "demonology"
−
and delete this:
+
and delete this part:
 
  {"advanced sorcery"}
 
  {"advanced sorcery"}
  
−
==Suggestions for simple changes to player_creatures.txt==
+
==Suggestions for simple changes to keeper_creatures.txt==
  
 
===Make it impossible for mages to get the archery technology===
 
===Make it impossible for mages to get the archery technology===
−
Change lines for evil keepers containing:
+
Change lines for dark mages containing:
 
  "archery"
 
  "archery"
 
Remove the text
 
Remove the text
 
  "archery"
 
  "archery"
−
 
−
===Remove female adventurers===
 
−
In the
 
−
# Adventures
 
−
section at the bottom delete this text:
 
−
ADVENTURER_F
 
  
 
==Suggestions for simple changes to immigration.txt==
 
==Suggestions for simple changes to immigration.txt==
−
Locate immigration.txt. It should like like [[Immigration.txt|this]]
+
Locate immigration.txt. It should look like [https://github.com/miki151/keeperrl/blob/master/data_free/game_config/immigration.txt this]
  
 
===Allow recruitment of gnomes===
 
===Allow recruitment of gnomes===
 
Find the
 
Find the
−
"Dark Keeper "
+
"dark_keeper"
 
section. Look at the block where:
 
section. Look at the block where:
−
  ids = { GOBLIN }
+
  ids = { "GOBLIN" }
 
Change it to:
 
Change it to:
−
  ids = { GOBLIN GNOME }
+
  ids = { "GOBLIN" "GNOME" }
  
 
===Recruiting all goblins without any insanity===
 
===Recruiting all goblins without any insanity===
 
In that section, remove the text:
 
In that section, remove the text:
−
  LastingEffect INSANITY
+
  Lasting { INSANITY }
 +
Wherever it is found.
  
 
==Suggestions for simple changes to campaign_villains.txt==
 
==Suggestions for simple changes to campaign_villains.txt==
−
Locate campaign_villains.txt. It should like like [[Campaign_Villains.txt|this]]
+
Locate campaign_villains.txt. It should look like [https://github.com/miki151/keeperrl/blob/master/data_free/game_config/campaign_villains.txt this]
  
−
===Remove green dragons from keeper campaigns===
+
===Remove all green dragons from keeper campaigns===
−
Delete the whole of the Line containing the text:
+
Delete all lines containing the text:
−
  GREEN_DRAGON
+
  "green_dragon"
  
−
===Remove red dragons from keeper campaigns===
+
===Remove all red dragons from keeper campaigns===
−
#Delete the whole of Line containing the text:
+
Delete all lines containing the text:
−
  RED_DRAGON
+
  "red_dragon"
  
 
==Suggestions for simple changes build_menu.txt==
 
==Suggestions for simple changes build_menu.txt==
−
Locate build_menu.txt. It should like like [[Build_Menu.txt|this]]
+
Locate build_menu.txt. It should look like [https://github.com/miki151/keeperrl/blob/master/data_free/game_config/build_menu.txt this]
  
 
===Make it free to fill in stone blocks===
 
===Make it free to fill in stone blocks===
 
On line filling in blocks change the text:
 
On line filling in blocks change the text:
−
  STONE 5
+
  "STONE" 5
 
to
 
to
−
  STONE 0
+
  "STONE" 0
 +
(hint: it is in the "structure" section).
  
 
===Allow building of iron training rooms without the iron working tech===
 
===Allow building of iron training rooms without the iron working tech===
 
On line for building iron dummies remove the text:
 
On line for building iron dummies remove the text:
−
  TechId "iron working"
+
  { TechId "iron working" }
 +
 
 +
==Setting your own targets==
 +
*Set yourself some simple targets for local modding.
 +
*Look at some of the other moddable text files. Gain familiarity.
 +
*After that, download a web mod and try and understand how it works.
 +
*After that hack the web mod (You can hack any of mine, I don't mind - SoftMonster 17.09.2020 - but parallel uploads could become annoying)
 +
*After that write your own web mod from scratch and upload it for the player community to show you the respect you deserve!
 +
 
 +
Good luck!
 +
Softmonster 17.09.2020 (Alpha 30)
  
 
[[Category : Modding Guide]]
 
[[Category : Modding Guide]]

Latest revision as of 05:32, 18 September 2020

Modding tutorial for KeeperRL (Overview)

  • The first recommendation is to get familiar with the existing modding system on KeeperRL
  • There are two types of mods on KeeperRL
    • Local mods (Edit the official game files locally) - Can't be uploaded onto the Web. Easier to learn for beginners.
    • Web mods (Write new mod files that modify, replace or append to the official game files) - Slightly tougher but you can upload them for other players to use.
  • Make some simple changes to the vanilla files, that is the official files (Try some of the suggestions below) and test the changes. Vanilla configs are found under "KeeperRL\datafree\gamedata\*.txt" 
Note, when changing vanilla configs you need to back them up in case you damage them.
If the worst happens, delete KeeperRL and reinstall it.
  • After learning to do local mods, install some existing Web Mods
  • Test them
  • Start writing your own Web mods

Suggestions for simple changes to workshops_menu.txt

Locate workshops_menu.txt. It should look like this linked file, which is found in the vanilla configs folder.

Remove wooden staffs from the workshop

Delete the line containing: 

WoodenStaff

under the 

"basic"
{
 "WORKSHOP"

section.

Reduce the cost of golden staffs

In the line containing 

GoldenStaff

under the 

"basic" section under the
  "FORGE" subsection

change the numbers in that line.

Sell rings of invisibility instead of wakefulness

Change the line containing 

RESTED

in the 

"JEWELER" subsection.

Change it to 

INVISIBLE

Change the conversion exchange rate for resources

In the 

"LABORATORY" section

experiment with changing the numbers (hint: look for the lines mentioning alchemical conversion).

Suggestions for simple changes to technology.txt

Locate technology.txt. It should look like this

Include a mention of heavy wooden clubs for the two-handed weapon tech

Change the line containing 

two-handed weapons

and edit the description text.

Remove the requirement for researching advanced sorcery before demonology

Change the line containing: 

"demonology"

and delete this part: 

{"advanced sorcery"}

Suggestions for simple changes to keeper_creatures.txt

Make it impossible for mages to get the archery technology

Change lines for dark mages containing: 

"archery"

Remove the text 

"archery"

Suggestions for simple changes to immigration.txt

Locate immigration.txt. It should look like this

Allow recruitment of gnomes

Find the 

"dark_keeper"

section. Look at the block where: 

ids = { "GOBLIN" }

Change it to: 

ids = { "GOBLIN" "GNOME" }

Recruiting all goblins without any insanity

In that section, remove the text: 

Lasting { INSANITY }

Wherever it is found.

Suggestions for simple changes to campaign_villains.txt

Locate campaign_villains.txt. It should look like this

Remove all green dragons from keeper campaigns

Delete all lines containing the text: 

"green_dragon"

Remove all red dragons from keeper campaigns

Delete all lines containing the text: 

"red_dragon"

Suggestions for simple changes build_menu.txt

Locate build_menu.txt. It should look like this

Make it free to fill in stone blocks

On line filling in blocks change the text: 

"STONE" 5

to 

"STONE" 0

(hint: it is in the "structure" section).

Allow building of iron training rooms without the iron working tech

On line for building iron dummies remove the text: 

{ TechId "iron working" }

Setting your own targets

  • Set yourself some simple targets for local modding.
  • Look at some of the other moddable text files. Gain familiarity.
  • After that, download a web mod and try and understand how it works.
  • After that hack the web mod (You can hack any of mine, I don't mind - SoftMonster 17.09.2020 - but parallel uploads could become annoying)
  • After that write your own web mod from scratch and upload it for the player community to show you the respect you deserve!

Good luck! 

Softmonster 17.09.2020 (Alpha 30)
Retrieved from "http://keeperrl.com/wiki/index.php?title=Gaining_familiarity_with_mods_on_KeeperRL&oldid=5242"