summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIndrajith K L2025-11-07 04:46:23 +0530
committerGitHub2025-11-07 04:46:23 +0530
commit839b3793a5ec4af58d4dabae85e8f8a211ace258 (patch)
tree37b07d916f921ddb028fbd729fedddb5d310c7d6 /docs
parent8c4b587a2347a911d165f0b4afcce116970ad7e5 (diff)
parentf3373d08c74e36b2161e1f4e4eef6aa7197352e0 (diff)
downloadreilua-enhanced-839b3793a5ec4af58d4dabae85e8f8a211ace258.tar.gz
reilua-enhanced-839b3793a5ec4af58d4dabae85e8f8a211ace258.tar.bz2
reilua-enhanced-839b3793a5ec4af58d4dabae85e8f8a211ace258.zip
Merge pull request #9 from cooljith91112/docs/html-documentation-improvements
docs: Add HTML documentation generator and improve documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/API.md90
-rw-r--r--docs/ASSET_LOADING.md83
-rw-r--r--docs/BUILD_SCRIPTS.md34
-rw-r--r--docs/CUSTOMIZATION.md18
-rw-r--r--docs/DOCUMENTATION_INDEX.md196
-rw-r--r--docs/EMBEDDING.md60
-rw-r--r--docs/SPLASH_SCREENS.md11
-rw-r--r--docs/UPGRADE_SUMMARY.md24
-rw-r--r--docs/ZED_EDITOR_SETUP.md24
9 files changed, 282 insertions, 258 deletions
diff --git a/docs/API.md b/docs/API.md
index 5359d3f..201fc1b 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -59,6 +59,96 @@ This function will be called when unloading resource that has allocated memory.
---
+## ReiLua Enhanced Functions
+
+These functions are part of ReiLua Enhanced Edition and provide additional functionality for asset loading and game development.
+
+---
+
+> RL.BeginAssetLoading( int totalAssets )
+
+Initialize asset loading progress tracking and show the loading screen. This displays a beautiful loading UI with progress bar and asset names.
+
+Parameters:
+- `totalAssets` (integer) - Total number of assets to load
+
+Example:
+```lua
+RL.BeginAssetLoading(10) -- We're loading 10 assets
+```
+
+Features:
+- Shows animated "LOADING..." text with dots
+- Displays progress bar with shimmer effect
+- Shows current asset name being loaded
+- Shows progress counter (e.g., "3 / 10")
+- 1-bit pixel art aesthetic
+
+---
+
+> RL.UpdateAssetLoading( string assetName )
+
+Update loading progress for the current asset. Call this after each asset is loaded to update the progress bar and display.
+
+Parameters:
+- `assetName` (string) - Name of the asset currently being loaded
+
+Example:
+```lua
+RL.UpdateAssetLoading("player.png")
+-- Load the asset here
+playerTexture = RL.LoadTexture("assets/player.png")
+```
+
+Notes:
+- Automatically increments the loaded asset counter
+- Updates the loading screen UI
+- Shows the asset name on screen
+- Updates progress bar percentage
+
+---
+
+> RL.EndAssetLoading()
+
+Finish asset loading and hide the loading screen. Call this after all assets have been loaded.
+
+Example:
+```lua
+RL.EndAssetLoading()
+```
+
+Complete Example:
+```lua
+function RL.init()
+ local assets = {}
+ local assetsToLoad = {
+ "assets/player.png",
+ "assets/enemy.png",
+ "assets/background.png",
+ "assets/music.wav",
+ }
+
+ -- Begin loading
+ RL.BeginAssetLoading(#assetsToLoad)
+
+ -- Load each asset
+ for i, path in ipairs(assetsToLoad) do
+ RL.UpdateAssetLoading(path)
+
+ if path:match("%.png$") then
+ assets[i] = RL.LoadTexture(path)
+ elseif path:match("%.wav$") then
+ assets[i] = RL.LoadSound(path)
+ end
+ end
+
+ -- Done loading
+ RL.EndAssetLoading()
+end
+```
+
+---
+
## Object unloading
Some objects allocate memory that needs to be freed when object is no longer needed. By default objects like Textures are unloaded by the Lua garbage collector. It is generatty however recommended to handle this manually in more complex projects. You can change the behavior with SetGCUnload.
diff --git a/docs/ASSET_LOADING.md b/docs/ASSET_LOADING.md
index a38a264..f5c5d8c 100644
--- a/docs/ASSET_LOADING.md
+++ b/docs/ASSET_LOADING.md
@@ -1,29 +1,28 @@
# Asset Loading System
-ReiLua includes a built-in asset loading system with a nice loading screen UI that automatically shows progress while assets are being loaded.
+ReiLua includes a built-in asset loading system with a loading screen UI that shows progress while assets are being loaded.
-## 🎨 Features
+## Features
-- **Automatic Progress Tracking** - Tracks how many assets have been loaded
-- **Beautiful Loading UI** - Modern, minimal loading screen with:
+- Automatic Progress Tracking - Tracks how many assets have been loaded
+- Loading UI with:
- Animated "Loading..." text with dots
- Smooth progress bar with shimmer effect
- Progress percentage (e.g., "3 / 10")
- Current asset name being loaded
- - Dark, clean color scheme
-- **Easy to Use** - Just 3 functions to show loading progress
-- **Works Everywhere** - Development and release builds
+- Easy to Use - Just 3 functions to show loading progress
+- Works in development and release builds
-## 📝 API Functions
+## API Functions
### RL.BeginAssetLoading(totalAssets)
Initialize asset loading progress tracking and show the loading screen.
-**Parameters:**
+Parameters:
- `totalAssets` (integer) - Total number of assets to load
-**Example:**
+Example:
```lua
RL.BeginAssetLoading(10) -- We're loading 10 assets
```
@@ -34,10 +33,10 @@ RL.BeginAssetLoading(10) -- We're loading 10 assets
Update the loading progress and display current asset being loaded.
-**Parameters:**
+Parameters:
- `assetName` (string) - Name of the asset currently being loaded
-**Example:**
+Example:
```lua
RL.UpdateAssetLoading("player.png")
```
@@ -50,12 +49,12 @@ Call this **after** each asset is loaded to update the progress bar.
Finish asset loading and hide the loading screen.
-**Example:**
+Example:
```lua
RL.EndAssetLoading()
```
-## 🚀 Quick Example
+## Quick Example
```lua
function RL.init()
@@ -87,7 +86,7 @@ function RL.init()
end
```
-## 💡 Complete Example
+## Complete Example
```lua
local assets = {}
@@ -146,16 +145,16 @@ function RL.draw()
end
```
-## 🎨 Loading Screen Appearance
+## Loading Screen Appearance
The loading screen features a clean 1-bit pixel art style:
-**Design:**
+Design:
- Pure black and white aesthetic
- Retro pixel art styling
- Minimal and clean design
-**Elements:**
+Elements:
- **Title**: "LOADING" in bold white pixel text
- **Animated Dots**: White pixelated dots (4x4 squares) that cycle
- **Progress Bar**:
@@ -167,52 +166,34 @@ The loading screen features a clean 1-bit pixel art style:
- **Asset Name**: Current loading asset in small white text
- **Corner Decorations**: White pixel art L-shaped corners in all 4 corners
-**Background:**
+Background:
- Pure black background (#000000)
- High contrast for maximum clarity
-**Color Palette:**
+Color Palette:
- White text and UI (#FFFFFF)
- Black background (#000000)
- Pure 1-bit aesthetic (inverted terminal style)
-**Visual Layout:**
-```
-[Black Background]
-
-┌─┐ ┌─┐
-│ │ LOADING □ □ │ │
-│ │ │ │
-│ │ ┌──────────────────┐ │ │
-│ │ │████████░░░░░░░░░░│ 3/10 │ │
-│ │ └──────────────────┘ │ │
-│ │ │ │
-│ │ player.png │ │
-│ │ │ │
-└─┘ └─┘
-
-[All text and UI elements in WHITE]
-```
-
-**Style Inspiration:**
+Style Inspiration:
- Classic terminal / console aesthetic
- MS-DOS loading screens
- 1-bit dithering patterns
- Chunky pixel borders
- Retro computing / CRT monitor style
-## 🔧 Customization
+## Customization
If you want to customize the loading screen appearance, you can modify the colors and sizes in `src/lua_core.c` in the `drawLoadingScreen()` function.
-## ⚡ Performance Tips
+## Performance Tips
1. **Call UpdateAssetLoading AFTER loading** - This ensures the progress updates at the right time
2. **Load assets in order of importance** - Load critical assets first
3. **Group similar assets** - Load all textures, then sounds, etc.
4. **Use descriptive names** - Shows better feedback to users
-## 📋 Example Asset Loading Patterns
+## Example Asset Loading Patterns
### Pattern 1: Simple List
```lua
@@ -260,26 +241,26 @@ end
RL.EndAssetLoading()
```
-## 🎮 When to Use
+## When to Use
-**Use the loading system when:**
+Use the loading system when:
- You have more than 5-10 assets to load
- Assets are large (images, sounds, fonts)
- Loading might take more than 1 second
- You want polished loading feedback
-**You can skip it when:**
+You can skip it when:
- You have very few, small assets
- Loading is nearly instant
- You prefer immediate game start
## ✨ Benefits
-- ✅ Polished user experience
-- ✅ User knows the game is loading, not frozen
-- ✅ Shows progress for large asset sets
-- ✅ Works with embedded assets
-- ✅ Minimal code required
-- ✅ Beautiful default UI
+- Polished user experience
+- User knows the game is loading, not frozen
+- Shows progress for large asset sets
+- Works with embedded assets
+- Minimal code required
+- Beautiful default UI
The loading system makes your game feel polished with just a few lines of code!
diff --git a/docs/BUILD_SCRIPTS.md b/docs/BUILD_SCRIPTS.md
index 875ef0b..191bd37 100644
--- a/docs/BUILD_SCRIPTS.md
+++ b/docs/BUILD_SCRIPTS.md
@@ -19,24 +19,24 @@ Fast iteration during game development with external Lua files and assets.
### Usage
-**Windows:**
+Windows:
```cmd
scripts\build_dev.bat
```
-**Linux/Unix:**
+Linux/Unix:
```bash
chmod +x scripts/build_dev.sh
scripts/build_dev.sh
```
### Features
-- ✅ No embedding - loads Lua and assets from file system
-- ✅ Fast build times
-- ✅ Edit code and assets without rebuilding
-- ✅ Automatic cleanup of embedded files
-- ✅ Warns if Lua files or assets are in build directory
-- ✅ Optional clean build: `scripts\build_dev.bat clean` or `scripts/build_dev.sh clean`
+- No embedding - loads Lua and assets from file system
+- Fast build times
+- Edit code and assets without rebuilding
+- Automatic cleanup of embedded files
+- Warns if Lua files or assets are in build directory
+- Optional clean build: `scripts\build_dev.bat clean` or `scripts/build_dev.sh clean`
### Output
- Development executable: `build/ReiLua.exe`
@@ -67,25 +67,25 @@ copy ..\your_game\assets\* assets\
### Usage
-**Windows:**
+Windows:
```cmd
scripts\build_release.bat
```
-**Linux/Unix:**
+Linux/Unix:
```bash
chmod +x scripts/build_release.sh
scripts/build_release.sh
```
### Features
-- ✅ Embeds all Lua files from `build/` directory
-- ✅ Embeds all assets from `build/assets/` folder
-- ✅ Creates single-file executable
-- ✅ Release optimization enabled
-- ✅ Verifies Lua files and assets before building
-- ✅ Shows summary of embedded files after build
-- ✅ Interactive confirmation before building
+- Embeds all Lua files from `build/` directory
+- Embeds all assets from `build/assets/` folder
+- Creates single-file executable
+- Release optimization enabled
+- Verifies Lua files and assets before building
+- Shows summary of embedded files after build
+- Interactive confirmation before building
### Output
- Release executable: `build/ReiLua.exe`
diff --git a/docs/CUSTOMIZATION.md b/docs/CUSTOMIZATION.md
index 388a894..22529be 100644
--- a/docs/CUSTOMIZATION.md
+++ b/docs/CUSTOMIZATION.md
@@ -322,11 +322,11 @@ YourGame.exe
```
Verify:
-- ✅ Executable has correct name
-- ✅ Icon appears in file explorer
-- ✅ Right-click → Properties shows correct info
-- ✅ Splash screens display correctly
-- ✅ Loading screen appears as expected
+- Executable has correct name
+- Icon appears in file explorer
+- Right-click → Properties shows correct info
+- Splash screens display correctly
+- Loading screen appears as expected
## Checklist: Release-Ready Customization
@@ -359,22 +359,22 @@ Before releasing your game:
## Troubleshooting
-**Icon doesn't change:**
+Icon doesn't change:
- Ensure .ico file is valid
- Rebuild completely (clean build)
- Clear icon cache (Windows): Delete `IconCache.db`
-**Properties don't update:**
+Properties don't update:
- Verify `resources.rc` syntax is correct
- Rebuild completely
- Check that resource compiler ran (check build output)
-**Splash screens don't show changes:**
+Splash screens don't show changes:
- Rebuild with clean build
- Check `scripts/embed_logo.py` ran successfully
- Verify logo files exist in `logo/` folder
-**Executable name unchanged:**
+Executable name unchanged:
- Check `CMakeLists.txt` project name
- Do a clean rebuild
- Verify cmake configuration step succeeded
diff --git a/docs/DOCUMENTATION_INDEX.md b/docs/DOCUMENTATION_INDEX.md
index fee3521..854bfd2 100644
--- a/docs/DOCUMENTATION_INDEX.md
+++ b/docs/DOCUMENTATION_INDEX.md
@@ -4,160 +4,115 @@ This document provides a quick reference to all available documentation for ReiL
## Core Documentation
-### 📘 [README.md](README.md) - **START HERE**
-The main documentation covering:
-- What is ReiLua Enhanced Edition
-- Complete attributions (Raylib, ReiLua, enhancements)
-- Quick start guide
-- All enhanced features overview
-- Command line options
-- Building from source (Windows, Linux, Mac, Raspberry Pi, Web)
-- Complete release workflow
-- Troubleshooting
-
-**Read this first!**
+**README.md** - START HERE
+
+The main documentation covering: what is ReiLua Enhanced Edition, complete attributions (Raylib, ReiLua, enhancements), quick start guide, all enhanced features overview, command line options, building from source (Windows, Linux, Mac, Raspberry Pi, Web), complete release workflow, and troubleshooting.
+
+Read this first!
---
## Feature-Specific Guides
-### 🎨 [SPLASH_SCREENS.md](SPLASH_SCREENS.md)
-Everything about splash screens:
-- How the dual splash screen system works
-- Custom text splash screen details
-- "Made using Raylib + ReiLua" screen details
-- Skipping splashes with `--no-logo` flag
-- Customizing text, logos, timing, and colors
-- Technical implementation details
-- Troubleshooting splash screen issues
-
-### 📦 [EMBEDDING.md](EMBEDDING.md)
-Complete guide to embedding:
-- Development vs release workflows
-- Embedding Lua files (`EMBED_MAIN=ON`)
-- Embedding assets (`EMBED_ASSETS=ON`)
-- Console control with `--log` flag
-- Complete release build workflow
-- Asset path consistency
-- Troubleshooting embedding issues
-
-### 📊 [ASSET_LOADING.md](ASSET_LOADING.md)
-Asset loading system documentation:
-- API functions (`BeginAssetLoading`, `UpdateAssetLoading`, `EndAssetLoading`)
-- Beautiful 1-bit pixel art loading screen
-- Complete examples
-- Loading patterns
-- Progress tracking
-- When to use the loading system
-- Customization options
-
-### 🔧 [BUILD_SCRIPTS.md](BUILD_SCRIPTS.md)
-Build automation documentation:
-- `scripts\build_dev.bat` / `scripts/build_dev.sh` - Development builds
-- `scripts\build_release.bat` / `scripts/build_release.sh` - Release builds
-- Features of each build type
-- Workflow examples
-- Customizing executable name, icon, and properties
-- Troubleshooting build issues
-
-### 🎨 [CUSTOMIZATION.md](CUSTOMIZATION.md)
-Complete rebranding guide:
-- Changing executable name
-- Adding custom icon
-- Customizing file properties (company name, version, etc.)
-- Customizing splash screens
-- Customizing loading screen
-- Complete rebranding example
-- Removing ReiLua branding (with attribution notes)
-
-### 💻 [ZED_EDITOR_SETUP.md](ZED_EDITOR_SETUP.md)
-Complete Zed editor setup:
-- Why Zed for ReiLua development
-- Installation guide
-- Lua Language Server configuration
-- Project setup with `.zed/settings.json`
-- Task configuration for quick testing
-- Essential keyboard shortcuts
-- Multi-cursor editing, split views, Vim mode
-- Troubleshooting LSP issues
-- Workflow tips and best practices
+**SPLASH_SCREENS.md** - Everything about splash screens
+
+How the dual splash screen system works, custom text splash screen details, "Made using Raylib + ReiLua" screen details, skipping splashes with `--no-logo` flag, customizing text, logos, timing, and colors, technical implementation details, and troubleshooting.
+
+**EMBEDDING.md** - Complete guide to embedding
+
+Development vs release workflows, embedding Lua files (`EMBED_MAIN=ON`), embedding assets (`EMBED_ASSETS=ON`), console control with `--log` flag, complete release build workflow, asset path consistency, and troubleshooting.
+
+**ASSET_LOADING.md** - Asset loading system documentation
+
+API functions (`BeginAssetLoading`, `UpdateAssetLoading`, `EndAssetLoading`), beautiful 1-bit pixel art loading screen, complete examples, loading patterns, progress tracking, when to use the loading system, and customization options.
+
+**BUILD_SCRIPTS.md** - Build automation documentation
+
+`scripts\build_dev.bat` / `scripts/build_dev.sh` for development builds, `scripts\build_release.bat` / `scripts/build_release.sh` for release builds, features of each build type, workflow examples, customizing executable name, icon, and properties, and troubleshooting.
+
+**CUSTOMIZATION.md** - Complete rebranding guide
+
+Changing executable name, adding custom icon, customizing file properties (company name, version, etc.), customizing splash screens, customizing loading screen, complete rebranding example, and removing ReiLua branding (with attribution notes).
+
+**ZED_EDITOR_SETUP.md** - Complete Zed editor setup
+
+Why Zed for ReiLua development, installation guide, Lua Language Server configuration, project setup with `.zed/settings.json`, task configuration for quick testing, essential keyboard shortcuts, multi-cursor editing, split views, Vim mode, troubleshooting LSP issues, and workflow tips.
---
## Technical Documentation
-### 📚 [API.md](API.md)
-Complete API reference:
-- 1000+ functions
-- All ReiLua/Raylib bindings
-- Function signatures
-- Raygui, Raymath, Lights, Easings, RLGL modules
-
-### 📝 [tools/ReiLua_API.lua](tools/ReiLua_API.lua)
-Lua annotations file:
-- Provides autocomplete in LSP-enabled editors
-- Function documentation
-- Copy to your project for IDE support
-
-### 🔄 [UPGRADE_SUMMARY.md](UPGRADE_SUMMARY.md)
-Technical implementation details:
-- Features added in this enhanced version
-- Files modified and added
-- Build options explained
-- Testing checklist
-- Known changes from original ReiLua
+**API.md** - Complete API reference
+
+1000+ functions, all ReiLua/Raylib bindings, function signatures, Raygui, Raymath, Lights, Easings, and RLGL modules.
+
+**tools/ReiLua_API.lua** - Lua annotations file
+
+Provides autocomplete in LSP-enabled editors, function documentation. Copy to your project for IDE support.
+
+**UPGRADE_SUMMARY.md** - Technical implementation details
+
+Features added in this enhanced version, files modified and added, build options explained, testing checklist, and known changes from original ReiLua
---
## Quick Reference by Task
-### "I want to start making a game"
-1. Read [README.md](README.md) - Quick Start section
+I want to start making a game
+
+1. Read README.md - Quick Start section
2. Look at examples in `examples/` folder
3. Use `ReiLua.exe --log --no-logo` for development
-### "I want to embed my game into a single .exe"
-1. Read [EMBEDDING.md](EMBEDDING.md)
+I want to embed my game into a single .exe
+
+1. Read EMBEDDING.md
2. Use `scripts\build_release.bat` / `scripts/build_release.sh`
-3. Follow the complete release workflow in [README.md](README.md)
+3. Follow the complete release workflow in README.md
-### "I want to add a loading screen"
-1. Read [ASSET_LOADING.md](ASSET_LOADING.md)
+I want to add a loading screen
+
+1. Read ASSET_LOADING.md
2. Use `RL.BeginAssetLoading()`, `RL.UpdateAssetLoading()`, `RL.EndAssetLoading()`
3. See complete examples in the guide
-### "I want to customize splash screens"
-1. Read [SPLASH_SCREENS.md](SPLASH_SCREENS.md)
+I want to customize splash screens
+
+1. Read SPLASH_SCREENS.md
2. Edit `src/splash.c` for text changes
3. Replace logo files in `logo/` folder
4. Rebuild project
-### "I want to rebrand the executable"
-1. Read [CUSTOMIZATION.md](CUSTOMIZATION.md)
+I want to rebrand the executable
+
+1. Read CUSTOMIZATION.md
2. Change project name in `CMakeLists.txt`
3. Replace `icon.ico`
4. Edit `resources.rc`
5. Customize splash screens
6. Rebuild
-### "I want to setup my code editor"
-1. Read [ZED_EDITOR_SETUP.md](ZED_EDITOR_SETUP.md)
+I want to setup my code editor
+
+1. Read ZED_EDITOR_SETUP.md
2. Install Zed and Lua Language Server
3. Copy `tools/ReiLua_API.lua` to your project
4. Create `.zed/settings.json` configuration
5. Set up tasks for quick testing
-### "I want to build ReiLua from source"
-1. Read [README.md](README.md) - Building from Source section
+I want to build ReiLua from source
+
+1. Read README.md - Building from Source section
2. Install prerequisites (CMake, compiler, Raylib, Lua)
3. Use `scripts\build_dev.bat` for development
4. Use `scripts\build_release.bat` for release
-### "I need API reference"
-1. Open [API.md](API.md)
+I need API reference
+
+1. Open API.md
2. Search for function name
3. See function signature and description
-4. Or copy [tools/ReiLua_API.lua](tools/ReiLua_API.lua) for autocomplete
+4. Or copy tools/ReiLua_API.lua for autocomplete
---
@@ -190,22 +145,21 @@ When adding new features, please:
## Documentation Standards
All documentation follows these standards:
-- ✅ Clear headings and structure
-- ✅ Code examples for all features
-- ✅ Troubleshooting sections
-- ✅ Cross-references to related docs
-- ✅ Platform-specific notes where needed
-- ✅ Emoji icons for visual scanning
-- ✅ Complete but concise
+- Clear headings and structure
+- Code examples for all features
+- Troubleshooting sections
+- Cross-references to related docs
+- Platform-specific notes where needed
+- Complete but concise
---
## Quick Links
-- **Original ReiLua**: https://github.com/Gamerfiend/ReiLua
-- **Raylib**: https://github.com/raysan5/raylib
-- **Lua**: https://www.lua.org/
-- **Zed Editor**: https://zed.dev/
+- Original ReiLua: https://github.com/Gamerfiend/ReiLua
+- Raylib: https://github.com/raysan5/raylib
+- Lua: https://www.lua.org/
+- Zed Editor: https://zed.dev/
---
diff --git a/docs/EMBEDDING.md b/docs/EMBEDDING.md
index 13f3752..59e9fb1 100644
--- a/docs/EMBEDDING.md
+++ b/docs/EMBEDDING.md
@@ -4,11 +4,11 @@ When you're ready to ship your game, you can embed all Lua files and asset files
## Development vs Release Workflow
-### 🔧 Development Build (Fast Iteration)
+Development Build (Fast Iteration)
-During development, use external files for quick iteration:
+During development, use external files for quick iteration.
-**Setup:**
+Setup:
```
GameFolder/
├── ReiLua.exe
@@ -19,24 +19,24 @@ GameFolder/
└── music.wav
```
-**Build:**
+Build:
```bash
cd build
cmake ..
cmake --build .
```
-**Benefits:**
-- ✅ Edit Lua files and re-run immediately
-- ✅ Edit assets and reload
-- ✅ Fast development cycle
-- ✅ Debug with `--log` flag
+Benefits:
+- Edit Lua files and re-run immediately
+- Edit assets and reload
+- Fast development cycle
+- Debug with `--log` flag
-### 📦 Release Build (Single Executable)
+Release Build (Single Executable)
-For distribution, embed everything into one file:
+For distribution, embed everything into one file.
-**Setup:**
+Setup:
```bash
cd build
@@ -50,7 +50,7 @@ copy ..\player.png assets\
copy ..\music.wav assets\
```
-**Build:**
+Build:
```bash
# Configure with embedding
cmake .. -DEMBED_MAIN=ON -DEMBED_ASSETS=ON
@@ -59,17 +59,17 @@ cmake .. -DEMBED_MAIN=ON -DEMBED_ASSETS=ON
cmake --build . --config Release
```
-**Result:**
+Result:
```
Distribution/
└── YourGame.exe (Everything embedded!)
```
-**Benefits:**
-- ✅ Single executable file
-- ✅ No external dependencies
-- ✅ Users can't modify game files
-- ✅ Smaller download (no separate files)
+Benefits:
+- Single executable file
+- No external dependencies
+- Users can't modify game files
+- Smaller download (no separate files)
## Quick Start
@@ -143,13 +143,13 @@ MyGame/
### Step 2: Customize Branding (Optional)
-**Change executable icon:**
+Change executable icon:
```bash
# Replace ReiLua's icon with yours
copy MyGame\icon.ico ReiLua\icon.ico
```
-**Edit executable properties:**
+Edit executable properties:
Open `ReiLua\resources.rc` and modify:
```rc
VALUE "CompanyName", "Your Studio Name"
@@ -158,7 +158,7 @@ VALUE "ProductName", "Your Game Name"
VALUE "LegalCopyright", "Copyright (C) Your Name, 2025"
```
-**Change executable name:**
+Change executable name:
Edit `ReiLua\CMakeLists.txt`:
```cmake
project( YourGameName ) # Change from "ReiLua"
@@ -171,7 +171,7 @@ See [CUSTOMIZATION.md](CUSTOMIZATION.md) for full details.
**Keep your paths consistent!** The embedding system now preserves the `assets/` prefix, so use the same paths in both development and release:
```lua
--- ✅ Correct - works in both dev and release
+-- Correct - works in both dev and release
playerImage = RL.LoadTexture("assets/player.png")
backgroundImg = RL.LoadTexture("assets/background.png")
musicSound = RL.LoadSound("assets/music.wav")
@@ -220,9 +220,9 @@ YourGameName.exe
```
Check console output for:
-- ✅ "ReiLua x.x.x" version info
-- ✅ No file loading errors
-- ✅ Game runs correctly
+- "ReiLua x.x.x" version info
+- No file loading errors
+- Game runs correctly
### Step 6: Package for Distribution
@@ -247,26 +247,26 @@ Your game is now ready to distribute as a single executable!
### Troubleshooting
-**Problem: "No .lua files found in build directory"**
+Problem: "No .lua files found in build directory"
```bash
# Solution: Copy Lua files to build directory
copy ..\*.lua .
```
-**Problem: "No files found in assets folder"**
+Problem: "No files found in assets folder"
```bash
# Solution: Create assets folder and copy files
mkdir assets
copy ..\*.png assets\
```
-**Problem: Game crashes on startup**
+Problem: Game crashes on startup
```bash
# Solution: Run with --log to see error messages
YourGameName.exe --log
```
-**Problem: Assets not loading**
+Problem: Assets not loading
- Verify assets are in `build/assets/` before building
- Check asset filenames match in your Lua code
- Use `--log` to see loading errors
diff --git a/docs/SPLASH_SCREENS.md b/docs/SPLASH_SCREENS.md
index 840a0d2..1d1f290 100644
--- a/docs/SPLASH_SCREENS.md
+++ b/docs/SPLASH_SCREENS.md
@@ -21,10 +21,10 @@ Each splash screen:
The logo images are **always embedded** into the executable in both development and release builds. This means:
-- ✅ No external logo files needed
-- ✅ Consistent splash screens across all builds
-- ✅ No risk of missing logo files
-- ✅ Clean appearance from the start
+- No external logo files needed
+- Consistent splash screens across all builds
+- No risk of missing logo files
+- Clean appearance from the start
### Asset Loading Integration
@@ -149,8 +149,7 @@ Here's what a typical game startup looks like with everything enabled:
ReiLua.exe MyGame/
```
-**User Experience:**
-
+User Experience:
1. **Splash Screen 1** (4.1 seconds)
- Custom text displayed in bold (default: "YOUR STUDIO NAME")
- Red background (Raylib color #E62937)
diff --git a/docs/UPGRADE_SUMMARY.md b/docs/UPGRADE_SUMMARY.md
index 35eb38b..c9c885f 100644
--- a/docs/UPGRADE_SUMMARY.md
+++ b/docs/UPGRADE_SUMMARY.md
@@ -91,7 +91,7 @@ Successfully ported embedded assets, splash screens, and asset loading features
### Quick Build (Recommended)
-**Development (Fast Iteration):**
+Development (Fast Iteration):
```bash
# Windows
scripts\build_dev.bat
@@ -100,7 +100,7 @@ scripts\build_dev.bat
scripts/build_dev.sh
```
-**Release (Single Executable):**
+Release (Single Executable):
```bash
# Copy files to build directory first
cd build
@@ -120,7 +120,7 @@ scripts/build_release.sh
### Manual Build
-**Development Build (Fast Iteration):**
+Development Build (Fast Iteration):
```bash
cmake -G "MinGW Makefiles" ..
mingw32-make
@@ -129,7 +129,7 @@ mingw32-make
- Fast edit-and-run workflow
- Use `--no-logo` to skip splash screens
-**Release Build (Single Executable):**
+Release Build (Single Executable):
```bash
# Copy Lua files and assets to build directory
copy ..\*.lua .
@@ -157,14 +157,14 @@ Options:
```
## Testing
-✅ Build compiles successfully
-✅ Logos and font embedded automatically
-✅ Asset loading API functions registered
-✅ Splash screens implemented and working
-✅ Console control working (Windows)
-✅ Documentation complete
-✅ SEGV crash fixed - window initializes before splash screens
-✅ Runs successfully with and without --no-logo flag
+ Build compiles successfully
+ Logos and font embedded automatically
+ Asset loading API functions registered
+ Splash screens implemented and working
+ Console control working (Windows)
+ Documentation complete
+ SEGV crash fixed - window initializes before splash screens
+ Runs successfully with and without --no-logo flag
## Known Changes from Original ReiLua
- `RL.config()` callback removed - window now initializes automatically
diff --git a/docs/ZED_EDITOR_SETUP.md b/docs/ZED_EDITOR_SETUP.md
index 626f06b..c1ba754 100644
--- a/docs/ZED_EDITOR_SETUP.md
+++ b/docs/ZED_EDITOR_SETUP.md
@@ -178,10 +178,10 @@ end
```
If autocomplete works, you should see:
-- ✅ Function suggestions when typing `RL.`
-- ✅ Parameter hints when calling functions
-- ✅ Documentation on hover
-- ✅ Constant values (RL.RED, RL.KEY_SPACE, etc.)
+- Function suggestions when typing `RL.`
+- Parameter hints when calling functions
+- Documentation on hover
+- Constant values (RL.RED, RL.KEY_SPACE, etc.)
---
@@ -237,7 +237,7 @@ Add these to suppress common false positives:
}
```
-**Common warnings and what they mean:**
+Common warnings and what they mean:
- `lowercase-global` - Using global variables with lowercase names (RL is intentional)
- `unused-local` - Local variables that aren't used
- `duplicate-set-field` - Redefining functions (callback functions are expected to be redefined)
@@ -267,7 +267,7 @@ function RL.init() end
RL.init = nil
```
-**Fix Steps:**
+Fix Steps:
1. **Update `tools/ReiLua_API.lua`** - Copy the latest version from the repository
2. **Or add to diagnostics.disable** in your configuration:
```json
@@ -277,11 +277,11 @@ RL.init = nil
```
3. **Restart Zed** to reload the configuration
-**Benefits of the new approach:**
-- ✅ No duplicate warnings
-- ✅ Still get autocomplete
-- ✅ Still get documentation on hover
-- ✅ Still get type checking
+Benefits of the new approach:
+- No duplicate warnings
+- Still get autocomplete
+- Still get documentation on hover
+- Still get type checking
---
@@ -431,4 +431,4 @@ Then copy `tools/ReiLua_API.lua` to your project root, and you're ready to go!
---
-**Happy Coding! 🚀**
+Happy Coding!