================================================================================
  Carnivores CE Renderer - Windows Release
================================================================================

Thank you for downloading Carnivores CE Renderer!

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

1. Extract the zip file to a folder (e.g., C:\Games\CarnivoresRenderer\)
2. Double-click CarnivoresRenderer.exe to run
3. The game should launch!

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

Missing DLL errors:
  → Make sure all .dll files from the zip are in the same folder as the .exe
  → You may need to install Visual C++ Redistributable:
    https://aka.ms/vs/17/release/vc_redist.x64.exe

App crashes:
  → Check console_output.log in the same folder as the .exe
  → The .pdb file helps with crash reports - keep it with the .exe
  → Make sure your graphics drivers are up to date

Graphics issues:
  → Make sure your GPU supports OpenGL 3.3+
  → Try reducing video.width and video.height in config.json
  → Disable video.dynamicShadows if you see rendering issues

================================================================================
  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.

IMPORTANT: config.json must be in the same folder as CarnivoresRenderer.exe!

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

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

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

Location for Custom Content:
  %LOCALAPPDATA%\CarnivoresCE\

  (This is typically: C:\Users\YourName\AppData\Local\CarnivoresCE\)

Directory Structure:
  %LOCALAPPDATA%\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:
     - Open File Explorer
     - Type %LOCALAPPDATA% in the address bar and press Enter
     - Create folder: CarnivoresCE
     - Inside CarnivoresCE, create: maps\c1 and 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:
     %LOCALAPPDATA%\CarnivoresCE\models\

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

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

Adding Custom Audio:
  1. Create the audio directory:
     %LOCALAPPDATA%\CarnivoresCE\audio\

  2. Copy your .WAV files to the audio\ folder (subfolders supported)
     Example: audio\calls\mycall.wav

  3. Use the in-game Config Editor to select audio files for:
     - Dinosaur/animal call sounds (huntable.calls array)
     - Rain ambient audio (weather.rainAmbient)

Adding Custom Images:
  1. Create the images directory:
     %LOCALAPPDATA%\CarnivoresCE\images\

  2. Copy your .TGA files to the images\ folder (subfolders supported)
     Example: images\loading\myscreen.tga

  3. Use the in-game Config Editor to select images for:
     - Loading screens (video.images.loading)
     - Award backgrounds (huntable.awardImage)
     - Call button images (huntable.callImage)

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)

================================================================================
  DEBUG SYMBOLS (.pdb file)
================================================================================

The included CarnivoresRenderer.pdb file contains debug symbols.

What it does:
  - Provides detailed crash reports with function names and line numbers
  - Helps developers diagnose issues you report
  - No performance impact (it's separate from the .exe)

Keep it if:
  - You encounter crashes and want to report them
  - You want detailed error messages

You can delete it if:
  - You need to save disk space (~2-5 MB)
  - The app runs fine for you

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

- Windows 10 or newer (64-bit)
- OpenGL 3.3+ compatible graphics card
- Visual C++ Redistributable (usually already installed)

================================================================================
  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:
  - console_output.log
  - startup_log.txt
  - Your Windows version and GPU info

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

Enjoy hunting! 🦖
