================================================================================
  Carnivores CE Renderer - macOS Release
================================================================================

Thank you for downloading Carnivores CE Renderer!

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

1. Extract the zip file
2. Double-click CarnivoresRenderer.app to run
3. The game should launch!

Note: The app is signed and notarized by Apple. If you still see a security
warning on first launch, right-click the app and select "Open" to bypass it.

================================================================================
  FIRST-TIME SETUP (if app won't open)
================================================================================

macOS may block the app because it was downloaded from the internet.

Solution:
  1. Open Terminal
  2. Navigate to the folder containing CarnivoresRenderer.app
  3. Run: xattr -cr CarnivoresRenderer.app
  4. Try opening the app again

This removes the quarantine attribute that macOS adds to downloaded files.

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

You can customize game settings without modifying the app bundle!

Create a User Config:
  1. Create the directory:
     mkdir -p ~/Library/Application\ Support/CarnivoresCE

  2. Copy the default config:
     cp CarnivoresRenderer.app/Contents/Resources/config.json \
        ~/Library/Application\ Support/CarnivoresCE/

  3. Edit with any text editor:
     open ~/Library/Application\ Support/CarnivoresCE/config.json

How It Works:
  - The game checks ~/Library/Application Support/CarnivoresCE/ first
  - If config.json exists there, it uses that
  - Otherwise, it uses the bundled config
  - Your settings persist across app updates!

Common Settings to Modify:
  - 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 ~/Library/Application Support/CarnivoresCE/config.json
  and the game will use the bundled defaults.

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

You can add your own maps and models without modifying the app bundle!

Location for Custom Content:
  ~/Library/Application Support/CarnivoresCE/

Directory Structure:
  ~/Library/Application Support/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 ~/Library/Application\ Support/CarnivoresCE/maps/c1
     mkdir -p ~/Library/Application\ Support/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 ~/Library/Application\ Support/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:
     mkdir -p ~/Library/Application\ Support/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:
     mkdir -p ~/Library/Application\ Support/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)

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

App won't open / shows "damaged" message:
  → Run: xattr -cr CarnivoresRenderer.app
  → This is normal for unsigned apps downloaded from the internet

App crashes on startup:
  → Check ~/Library/Application Support/CarnivoresCE/config.json for errors
  → Delete it to reset to defaults
  → Check the app's crash logs in Console.app

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

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

- macOS 10.15 (Catalina) or newer
- Apple Silicon (M1/M2/M3) or Intel Mac
- OpenGL 3.3+ compatible graphics

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

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

For more detailed configuration options, see the bundled config.json
in CarnivoresRenderer.app/Contents/Resources/

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

Enjoy hunting! 🦖
