================================================================================
  Carnivores CE Renderer - Linux Release
================================================================================

Thank you for downloading Carnivores CE Renderer!

================================================================================
  QUICK START
================================================================================

1. Extract the zip file to a folder (e.g., ~/Games/CarnivoresRenderer/)
2. Make the executable runnable: chmod +x CarnivoresRenderer
3. Run: ./CarnivoresRenderer
4. The game should launch!

================================================================================
  REQUIREMENTS
================================================================================

Runtime Libraries:
  The following libraries must be installed on your system:

  Ubuntu/Debian:
    sudo apt install libglfw3 libopenal1

  Fedora:
    sudo dnf install glfw openal-soft

  Arch Linux:
    sudo pacman -S glfw openal

  openSUSE:
    sudo zypper install libglfw3 openal-soft

Graphics:
  - OpenGL 3.3+ compatible graphics driver
  - For best results, use proprietary GPU drivers (NVIDIA/AMD)

================================================================================
  TROUBLESHOOTING
================================================================================

"Permission denied" when running:
  -> Run: chmod +x CarnivoresRenderer

Missing library errors:
  -> Install the required libraries (see REQUIREMENTS above)
  -> Run: ldd ./CarnivoresRenderer
     This shows which libraries are missing

OpenGL errors / Black screen:
  -> Make sure your graphics drivers are up to date
  -> For NVIDIA: Install the proprietary driver
  -> For AMD: Use Mesa 21.0+ or AMDGPU-PRO
  -> Try running with: MESA_GL_VERSION_OVERRIDE=3.3 ./CarnivoresRenderer

No audio:
  -> Make sure PulseAudio or PipeWire is running
  -> Check that OpenAL is installed: apt install libopenal1

App crashes on startup:
  -> Check ~/.local/share/CarnivoresCE/logs/ for error logs
  -> Delete config.json and try again with defaults
  -> Run from terminal to see error messages

Wayland issues:
  -> Try running with X11: GDK_BACKEND=x11 ./CarnivoresRenderer
  -> Or set: GLFW_PLATFORM=x11 ./CarnivoresRenderer

================================================================================
  CUSTOMIZING SETTINGS
================================================================================

Edit config.json in the same folder as the executable.

Common Settings:
  - video.fullscreen - Set to true or false
  - video.width / video.height - Window dimensions (e.g., 1920, 1080)
  - camera.fov - Field of view in degrees (60-120)
  - debug.* - Enable various debug visualizations

To Reset:
  Delete config.json and extract a fresh copy from the original zip.

User Config Location (Alternative):
  The game also checks ~/.config/CarnivoresCE/config.json first.
  If you want your settings to persist across game updates, create:
    ~/.config/CarnivoresCE/config.json

================================================================================
  CUSTOM MAPS AND MODELS
================================================================================

You can add your own maps and models for use in the game!

Location for Custom Content:
  ~/.local/share/CarnivoresCE/

Directory Structure:
  ~/.local/share/CarnivoresCE/
    maps/
      c1/           <- Carnivores 1 maps (.MAP and .RSC files)
      c2/           <- Carnivores 2 / Ice Age maps (.MAP and .RSC files)
    models/         <- Character models (.CAR files)
    audio/          <- Sound files (.WAV files for calls, ambient, etc.)
    images/         <- Image files (.TGA files for loading screens, etc.)

Adding Custom Maps:
  1. Create the maps directory:
     mkdir -p ~/.local/share/CarnivoresCE/maps/c1
     mkdir -p ~/.local/share/CarnivoresCE/maps/c2

  2. Copy your map files:
     - For C1 maps: place both MAPNAME.MAP and MAPNAME.RSC in maps/c1/
     - For C2 maps: place both MAPNAME.MAP and MAPNAME.RSC in maps/c2/
     - Maps can be in subfolders (e.g., maps/c2/custom/mymap.MAP)

  3. Use the in-game Config Editor (ESC menu) to select your map,
     or edit config.json manually:
     "map": {
       "type": "C2",
       "map": "maps/c2/MYMAP.MAP",
       "rsc": "maps/c2/MYMAP.RSC"
     }

Adding Custom Models:
  1. Create the models directory:
     mkdir -p ~/.local/share/CarnivoresCE/models

  2. Copy your .CAR files to the models/ folder

  3. Reference them in config.json spawns or weapons:
     "file": "models/mymodel.car"

Notes:
  - The game checks the user directory first, then falls back to bundled files
  - Use the in-game Config Editor (press ESC) to easily select custom content
  - Map files must have matching .MAP and .RSC files with the same name
  - Audio files must be in WAV format
  - Image files must be in TGA format (24 or 32-bit)

================================================================================
  FILE LOCATIONS
================================================================================

Config files:
  ~/.config/CarnivoresCE/config.json      (user config, takes priority)
  ./config.json                            (bundled default)

Log files:
  ~/.local/share/CarnivoresCE/logs/

Cache files (shadows, etc.):
  ~/.cache/CarnivoresCE/

Custom content:
  ~/.local/share/CarnivoresCE/

================================================================================
  SUPPORT & MORE INFO
================================================================================

Project: https://github.com/carnivores-ce/carnivores-ce-renderer
Issues: https://github.com/carnivores-ce/carnivores-ce-renderer/issues

If you encounter crashes, please include:
  - Output from running in terminal
  - Log files from ~/.local/share/CarnivoresCE/logs/
  - Your distro, kernel version, and GPU info (glxinfo | grep -i vendor)

================================================================================

Enjoy hunting!
