- Have Python installed
- Make sure PySide6, PyQt6, PyYAML, Pillow, and appdirs are installed (
pip install <library>in a command prompt if they are not) - Open command prompt type
python3and drag themain.pyfile into the prompt (or simply click on main.py if you're using windows).
The python file will automatically adjust it's work directory to where it was run, so there is no worry about having to change directory.
This is a cave creator designed around being geared to full game applications rather than challenge mode or CaveNet (which has not been reimplmented, sorry).
In addition to being a GUI cave editor, there are features such as:
- Units file editor
- CaveGen integration
- More Non-Vanilla integrations, especially with modded enemies
- Chemi/chemicalqq (mayabyte) & JHawk4 (JHaack4) for CaveGen
- Yoshi2 (RenolY2) for the simpiler Yaz0/Rarc library
- LagoLunatic for the wwlib library
- The Pikmin Technical Knowledge Base
- 251 & New Year presets
- Progress Bars
If there is anything you would like to see added, let me know
In the repository, you have have noted a folder named presets containing a signular preset titled pikmin2, this folder is designed to allow you to create custom enemy and treasure groups for a hack without having to re-write any code within cave creator beforehand.
this is a .json file containing every enemy, it is formated like this:
{internal name (string) :
{"common" : common name (string),
"id" : internal id (int),
"use" : show teki (bool),
"fall" : enemy can fall (bool),
"item" : enemy can drop held item (bool)}
}
this is a .json file containing every treasure, it is formated like this:
{internal name (string) : common name (string) }
this is a file containing the locations of items in use with the editors, you do not need to worry about it.
this is a folder containing .pngs of each enemy listed in teki.json
this is a folder containing .pngs of each treasure listed in item.json
this is a large units.txt file containing every unit, used in the units editor
- Copy the pikmin2 preset and rename it to whatever you'd like
- Add any custom treasures' names into item.json
- Add any custom enemies' names into teki.json
- Add any custom units into all_units.txt
- (optional) update tekiIcons
- (optional) update itemIcons
you're now ready to use the preset for whatever mod you'd like
Preset settings can be found in the options menu, and has it's own button and text box for it.
Attempting to load or edit the presets of a non-existing directory will throw a warning and disallow you from doing so, make sure it's spelt right and using correct capitalization.
After opening the presets menu, there will be 5 buttons, excluding Save Preset Settings. These buttons are:
- Open units txts from folder
- Open caves from folder
- Open units arc from folder
- Open lighting from folder
- Set all from root folder
The text boxes below them contain the locations that will be opened from when required during usage from the editors. To set it up properly, simply click the Set all from Root folder button, and open the root of the hack's folder, then press Save Preset Settings and close the tab - your preset it is ready to be used for modding, have fun!
If you're using a file framework that restructures the locations and names of the folders, the Set all from Root folder button will fail to find the folders for each setting - if that is the case, you will have to path to the folders containing the items for each setting by hand.
Updates the units that cavegen uses, this is a seperate option because of how slow it is, it may take a minute or two to complete, but is worth it from cavegen integration
The preset folder that the game will draw from, if it does not exists it will default to pikmin2 please do not delete the pikmin2 folder.
These are the folders that cavegen will pull from, as well as the default directory for opening files.
It's recomended to select from root folder, but if you are using something like Neo-Reconstructed you will have to set the folders yourself.
- Show Useless Teki: Shows teki that do nothing/crash
- Show CapType Slider: shows the editor for captype, if you changed its purpose
- Show Item Weight Slider: Shows the slider from item weight, which is a horrible idea in general
- Show Gate Names: Shows the names of gates, for if you made them do something
- Show Internal group names: Uses Teki A or Teki F instead of Easy or Special
- Show Internal Names: Uses internal names from the games files instead of the common names from the piklopedia/treasure hoard
- Always Enable Capinfo: Makes the {f015} paramater allways 1, and disables the option to change it
- Remove Useless Teki Options: Removes options that wouldn't do anything on some tekis.
Open Cave will route you to you're preset's caves folder, where you can select a cave file to load into the editor with.
New Cave will jump you straight into the editor with a completely blank cave.
Load Backup will route you to the Backups folder, in which backed-up .pickle files will be stored, clicking on one of them will load the backed-up cave.
To save the current cave to a new location, select File -> Save As or use Ctrl + Shift + S, this will open a dialoge to save the file the a desired location.
To overwrite the cave that is being worked on, select File -> Save or use Ctrl + S, this will overwrite the file that is saved over, so be careful.
To backup to the backups folder, selected File -> Backup or use Ctrl + B, this will create a .pickle backup that can be easily loaded.
pickling is not a secure method of storage, do not accept .pickle files from people you do not trust.
In the top center of the cave editor is an enumerated bar of the floors within the cave. Left of that bar is two buttons, one that says Add Floor and one that says Remove Floor, their functions are self explanatory
Remove a floor by accident? Do not fear, the floor itself is not deleted, clicking Add Floor will return the floor back before it was deleted.
The first section of the floor is denoted as Floorinfo, and it looks like this:
- Units File: A .txt containing units instructions
- Lighting File: A .ini file containing lighting instuctions
- Skybox: The name of the VRBOX in use
- Spawn Collision Plane: Tells the game to spawn an invisable floor of collision if checked, used in some cave themes
- Spawn Geyser: Tells the game to spawn an exit geyser on this sublevel
- Clogged Hole: Tells the game whether it should put a clog on the hole this sublevel or not
- Teki Number: Total amount of enemies the game will spawn on this floor
- Item Number: Total amount of items the game will spawn on this floor (not including items in enemies)
- Gate Number: Total amount of gates the game will spawn on this floor
- Room Number: Total amount of rooms the game will spawn when creating the floor
- Corridor Chance: Chance of a corridor being selected to spawn instead of a room, values above 0.20 are disencouraged
- Dead End %: Chance of a hallway spawning a dead end instead
- Echo Type: The type of echo used within the sublevel, soil is the strongest, toy is the weakest
- Music Type: The type of music used within the sublevel, Normal plays the regular music defined in Totaka's folder, Boss silences the floor until a boss encounter, Rest plays rest floor music.
- Wraith Timer: Time until the Waterwraith spawns if it is placed in a level and not used on the final floor.
- Spawn Seesaws: Tells the game to randomly place 2 conected seesaws throughout the level
- Use Capinfo: Toggles the Capinfo box
The second section of the floor is denoted as Tekinfo, and it looks like this:
In order to save space, these are not labeled within the cave creator
- Teki Name: A dropdown menu featuring every enemy, can be changed to a text menu in settings, or changed to a custom preset.
- Held Item: A dropdown meanu featuring every treasure can be changed to a text menu in settings, or changed to a custom preset.
- Fall Type: A dropdown menu for every fall activation, None means it will not fall.
- Spawn Count: The leftmost Number Slider, sets how many teki the game will spawn
- Weight: The rightmost Number Slider, sets how many filler enemies the game will spawn
- Spawn Group: The type of location the game will spawn the enemy at, Unknown will not spawn one. Can be changed to internal names in settings
- Add Teki: Adds another enemy to TekiInfo
- Remove Teki: Removes the bottom-most enemy
The third section of the floor is Iteminfo, it looks like this: 
In order to save space, these are not labeled within the cave creator
- Item: A dropdown meanu featuring every treasure can be changed to a text menu in settings, or changed to a custom preset.
- Count: The number of this item to be spawned, only change this for challenge mode levels.
- Weight: Not shown in the above photo, and must be enabled in settings; this is the amount of filler treasures to spawn, not recomended.
- Add Item: Adds another treasure to ItemInfo
- Remove Item: Removes the bottom-most treasure
The forth section of the floor in GateInfo, it looks like this:
In order to save space, these are not labeled within the cave creator
- Name: Not shown in the above photo, a text bar with the name of the gate, this does not effect the cave and is not recomended.
- Life: The amount of health the gate has, a pikmin deals 20 damage per second.
- Weight: THIS IS NOT THE SPAWN NUMBER - This is the weighing of the gate, the amount of gates to spawn is located in floorinfo.
- Add Gate: Adds another gate to gateinfo
- Remove Gate: Removes the bottom-most gate
The fifth and final section of the floor is CapInfo, it looks like this
In order to save space, these are not labeled within the cave creator
You may notice that the capinfo section is missing, that is because it has been disabled in floorinfo and can be re-enabled at any time.
- Teki Name: A dropdown menu featuring every enemy, can be changed to a text menu in settings, or changed to a custom preset.
- Held Treasure: A dropdown meanu featuring every treasure can be changed to a text menu in settings, or changed to a custom preset.
- Fall Type: A dropdown menu for every fall activation, None means it will not fall.
- Spawn Num: The leftmost Number Slider, sets how many teki the game will spawn
- Weight: The rightmost Number Slider, sets how many filler enemies the game will spawn
- Captype: If disabled, this will make 2 of an enemy spawn in the cap instead of one, useful for things like anode beetles, but not generally recomended.
- Add Cap Teki: Adds another cap enemy to CapInfo
- Remove Cap Teki: Removes the bottom-most enemy
- Have Java installed
- Make sure the units in cavegen are updated (in settings)
- Make sure your preset has all the directories
- Make sure all your settings are correct missing hallway units will cause cavegen to crash
Using Actions -> CaveGen or Ctrl + G will generate an example layout and show you the seed, use this to "playtest" your cave levels quickly
Using Actions - > CaveInfo or Ctrl + I will display the caveinfo, use this to preview the units and their spawnpoints
Open Units will route you to you're preset's units folder, where you can select a units file to load into the editor with.
New Units will jump you straight into the editor with a completely blank unit file.
Load Backup will route you to the Backups folder, in which backed-up .pickle files will be stored, clicking on one of them will load the backed-up cave.
To save the current units to a new location, select File -> Save As or use Ctrl + Shift + S, this will open a dialoge to save the file the a desired location.
To save the units file, select File -> Save or use Ctrl + S, this will overwrite the file that is saved over, so be careful.
To backup to the backups folder, selected File -> Backup or use Ctrl + B, this will create a .pickle backup that can be easily loaded.
pickling is not a secure method of storage, do not accept .pickle files from people you do not trust.
At the bottom of the screen there is a dropdown containing every unit defined in all_units.txt within the preset
The unit's name will a button, clicking on it will reveal the unit's meta-data, the meta-data is unique to the file.
Open Light will route you to you're preset's light folder, where you can select a light file to load into the editor with.
New Light will jump you straight into the editor with a completely blank lighting file.
Load Backup will route you to the Backups folder, in which backed-up .pickle files will be stored, clicking on one of them will load the backed-up cave.
To save the current light to a new location, select File -> Save As or use Ctrl + Shift + S, this will open a dialoge to save the file the a desired location.
To save the units file, select File -> Save or use Ctrl + S, this will overwrite the file that is saved over, so be careful.
To backup to the backups folder, selected File -> Backup or use Ctrl + B, this will create a .pickle backup that can be easily loaded.
pickling is not a secure method of storage, do not accept .pickle files from people you do not trust.
Self explanitory, no orb is used when the player doesn't have stellar orb, stellar orb lighting is used when the player has orb.
Self explanitory, this is the distance from the light source, the lower the value, the stronger the light
This is the main color that starts from the player.
This is the secondary color that is more noticible in the outer section of the player
This is the specular light of the lighting file
This is the ambient light of the lighting file
The fog color and distance
This is the shadows of enemies