PokeWilds Documentation

repository·main·Indexed 23 days ago

https://github.com/sheerst/pokewilds

A Gen 2-inspired procedural generation game engine built using libGDX, featuring large biomes, monster habitats, and unique field moves. Documentation covers installation across Windows, Linux, and Mac, configuration via settings.txt, save file restoration, and the use of Dev Mode for world manipulation and debugging.

Tokens
1K
Snippets
2
Records
8
Agent score
34%

What's inside PokeWilds

  1. View game logs via CLI mode (Windows 10)

    main

    To see real-time logs (such as currently playing songs or error messages) in a command window:

    1. Open the folder containing pokewilds.exe.
    2. Shift + right-click in the folder and select 'Open powershell window here'.
    3. Type cmd and press Enter.
    4. Type pokewilds.exe and press Enter.

    The game will launch, and various information will be written to the terminal window.

    pokewilds.exe
  2. Run PokeWilds in Dev Mode (Windows 10)

    main

    To enable developer capabilities, run the executable with the dev flag via the command line:

    1. Open the folder containing pokewilds.exe.
    2. Shift + right-click in the folder and select 'Open powershell window here'.
    3. Type cmd and press Enter.
    4. Type pokewilds.exe dev and press Enter.

    Note: If you encounter OpenGL errors or keyboard input issues, try adding angle_gles20 to the command:

    pokewilds.exe dev angle_gles20
    pokewilds.exe dev
  3. Use Dev Mode capabilities

    main

    When running in Dev Mode, you can use the following tools to manipulate the game world:

    • Paint Tiles: Click anywhere on the screen to paint tiles.
      • Ctrl: Reduce brush size.
      • Alt: Increase brush size.
      • C and V: Cycle through available tiles.
    • Super Movement: Hold Space bar to run very fast, prevent wild encounters, and walk through walls.
    • Screenshots: Press L to take a full-map screenshot (saved to the game directory; the game will freeze briefly).
    • Camera Controls:
      • WASD: Pan the camera around the map.
      • Q and E: Zoom the camera in/out.
  4. Restore a corrupted save file from backup

    main

    If your save file becomes corrupted, you can attempt to restore it using the automatic backup file located in your game folder.

    1. Locate the backup file named <game-name>.sav.backup.
    2. Rename <game-name>.sav.backup to <new-game-name>.sav.zip.
    3. Extract the contents of the zip file.
    4. Ensure the extracted contents result in a directory named <new-game-name>.sav/ containing files such as game, map0,0, etc.
    5. Load the new save file (<new-game-name>) from the game's menu.
  5. Configure settings.txt

    main

    You can customize game behavior and key mappings by editing the settings.txt file.

    Important Rules:

    • Do not include spaces around the = sign.
    • Key mappings (using keyboard- lines) must use capitalized key names.

    Available Keys:

    • muteMusic: Set to true to mute all in-game music.
    • specPhysSplitEnabled: Set to true or false to toggle the special/physical move split.
    • keyboard-[KEY]: Used to remap controls.
  6. Troubleshoot common PokeWilds issues

    main

    Save Data Loss

    • Windows Search: Do not run the game through Windows search results; double-click pokewilds.exe directly.
    • macOS: Do not double-click pokewilds.jar directly; follow the README.txt instructions to create a safe launcher.

    Display and Performance

    • Black screen at night: Use pokewilds-compat.exe instead of the standard executable.
    • World Generation Stuck: If generation takes longer than 5-10 minutes, close the game and retry.
    • OpenGL Errors: Update graphics drivers or switch from dedicated to integrated graphics.

    File Path and Environment Issues

    • OneDrive: Avoid running the game from a Windows OneDrive folder.
    • Special Characters: Ensure the game directory path does not contain an exclamation mark (!).
    • System Language: If the game fails to generate maps, ensure your Windows system language is set to English.