🎵 RMP - Ray Media Platform

✨ What is RMP?

🚀 Key Features

🎨 Advanced Theme System

🔌 Robust Plugin Architecture

🎵 Professional Music Player

🎮 Game Development Platform

⚡ High-Performance Engine

🎬 Demo

3D Cube Renderer

Digital Clock Widget

🏗️ Architecture Overview

┌─────────────────────────────────────────┐
│ Lua Application Layer │
├─────────────────────────────────────────┤
│ Themes │ Plugins │ Templates │ Config │
├─────────────────────────────────────────┤
│ RMP Framework (Lua) │
├─────────────────────────────────────────┤
│ C Engine Core │
├─────────────────────────────────────────┤
│ Terminal │ Audio │ Input │ VirtualTerm │
└─────────────────────────────────────────┘

📦 Installation

Prerequisites

# Debian/Ubuntu
sudo apt-get install gcc build-essential
# macOS (with Homebrew)
brew install gcc
# Windows (MSYS2/MinGW)
choco install gcc
# Install MinGW-w64 using chocolaty package manager

Build from Source

Unix like build

git clone https://github.com/abdorayden/raymp.git
cd raymp/install
./install.sh compile -v && sudo ./install.sh install -v
cd ..
./rmp

Windows Build

git clone https://github.com/abdorayden/raymp.git
cd raymp\install
install.bat compile
install.bat install
cd ..
rmp.exe

Verifying Installation

# Start the music player (default)
./rmp
# Check version and help
./rmp --version
./rmp --help

⚡ Quick Start

1. Launch Default rmp templates

./rmp

2. Create Your First TUI App with rmp framework only

-- hello_world.lua
-- NOTE: rmp framework installed by rmp engine
local api = require("rmp.rmp")
local frame = api.Frame.new()
frame:setFps(60)
local window = api.Window.new(1):createWindow(
 "Hello RMP!", 40, 10, 5, 5, nil, nil, nil,
 function(x, y, w, h)
 return api.Text.new("Welcome to RMP Framework!", 
 x+2, y+2, api.FGColors.Brights.Green)
 end
)
while true do
 frame:add(window)
 local key = api.Terminal:handleKey()
 if key == api.KEY_Q then break end
 frame:run(key)
end

3. Load a Custom Theme

cat ~/.rmp/init.lua # config file
# this is the place where u configure your rmp audio player
# the (themes/templates) are located in ~/.rmp/themes/ folder
# you can download or create you own template and add it to this path 
# and load it in init.lua config file

4. Load a plugins

cat ~/.rmp/init.lua # config file
# this is the place where u configure your rmp audio player
# the (plugins) are located in ~/.rmp/plugins/ folder
# you can download or create you own plugin and add it to this path 
# and load it in init.lua config file

🎯 Usage Examples

🎵 Music Player (Default Mode)

-- Default mode - just run ./rmp
-- Features included:
-- • File browser with music library scanning
-- • Playback controls (play, pause, seek, volume)
-- • Playlist management
-- • Audio format detection
-- • Keyboard shortcuts for all functions

📱 Custom TUI Application

-- multi_window_app.lua
local api = require("rmp.rmp")
-- Create application frame
local frame = api.Frame.new()
frame:setFps(60)
-- Main window with dynamic content
local mainWindow = api.Window.new(1):createWindow(
 "Multi-Window Demo", "w-4", "h-8", 2, 2, 
 api.BoxDrawing.LightBorder, api.BGColors.NoBrights.Black, nil,
 function(x, y, w, h)
 local vterm = api.VirtualTerminal.new()
 vterm:writeText(x+1, y+1, "Main Content Area", api.FGColors.Brights.White)
 vterm:writeText(x+1, y+3, "Press TAB to switch panels", api.FGColors.NoBrights.Yellow)
 return vterm
 end
)
-- Status bar
local statusWindow = api.Window.new(2):createWindow(
 nil, "w-2", 3, 1, "h-3",
 api.BoxDrawing.NoBorder, api.BGColors.NoBrights.Blue, nil,
 function(x, y, w, h)
 local vterm = api.VirtualTerminal.new()
 vterm:writeText(x+1, y+1, "Status: Ready", api.FGColors.Brights.White)
 return vterm
 end
)
-- Event loop
while true do
 frame:add(mainWindow)
 frame:add(statusWindow)
 local key = api.Terminal:handleKey()
 if key == api.KEY_Q then break end
 frame:run(key)
end

🎮 2D Game Development

-- simple_game.lua
local api = require("rmp.rmp")
local gameState = {
 playerX = 10, playerY = 5,
 enemies = {{x=20, y=8}, {x=30, y=12}},
 score = 0
}
local frame = api.Frame.new()
frame:setFps(30) -- 30 FPS for smooth gameplay
local gameWindow = api.Window.new(1):createWindow(
 "RMP Game Engine Demo", 60, 20, 5, 2,
 api.BoxDrawing.DoubleBorder, api.BGColors.NoBrights.Black, nil,
 function(x, y, w, h)
 local vterm = api.VirtualTerminal.new()
 
 -- Draw player
 vterm:writeText(x + gameState.playerX, y + gameState.playerY, 
 "@", api.FGColors.Brights.Green)
 
 -- Draw enemies
 for _, enemy in ipairs(gameState.enemies) do
 vterm:writeText(x + enemy.x, y + enemy.y, 
 "X", api.FGColors.Brights.Red)
 end
 
 -- Draw HUD
 vterm:writeText(x+1, y+1, "Score: " .. gameState.score, 
 api.FGColors.Brights.Yellow)
 
 return vterm
 end
)
-- Game input handling
gameWindow:addEventListener(api.EventType.Keyboard, function(key)
 if key == api.KEY_W then
 gameState.playerY = math.max(1, gameState.playerY - 1)
 elseif key == api.KEY_S then
 gameState.playerY = math.min(18, gameState.playerY + 1)
 elseif key == api.KEY_A then
 gameState.playerX = math.max(1, gameState.playerX - 1)
 elseif key == api.KEY_D then
 gameState.playerX = math.min(58, gameState.playerX + 1)
 end
end)
-- Game loop
while true do
 local key = api.Terminal:handleKey()
 if key == api.KEY_Q then break end
 
 frame:add(gameWindow)
 -- Update game state here (enemy movement, collision detection, etc.)
 
 frame:run(key)
end

🎨 (Theme/Template) Development

Creating a Custom (Theme/Template)

-- themes/cyberpunk_theme.lua
-- Cyberpunk-inspired theme with neon colors and futuristic elements
-- the template lua file are returned a table with tables that has a different id's and types 
local api = require("rmp.rmp")
return {
 -- main window with a children
 {
 id = 1,
 type = "Window",
 title = {
 type = "Text",
 value = "▋█▊ RMP CYBERPUNK ▊█▋",
 foregroundColor = api.FGColors.Brights.Magenta,
 backgroundColor = api.BGColors.NoBrights.Black,
 style = api.TextStyle.Bold
 },
 width = "w",
 height = "h", 
 x = 1,
 y = 1,
 border = api.BoxDrawing.DoubleBorder,
 backgroundColor = api.BGColors.NoBrights.Black,
 children = {
 -- Header with animated elements
 {
 id = 2,
 type = "Window",
 title = {
 type = "Text",
 value = "",
 dynamic = function(ctx)
 -- ctx table for the self object
 local time = os.date("%H:%M:%S")
 return "⚡ NEURAL INTERFACE ACTIVE ⚡ " .. time
 end,
 foregroundColor = api.FGColors.Brights.Cyan,
 backgroundColor = api.BGColors.NoBrights.Magenta,
 style = api.TextStyle.Bold,
 },
 width = "w - 2",
 height = 4,
 x = 2,
 y = 2,
 border = api.BoxDrawing.LightBorder,
 backgroundColor = api.BGColors.NoBrights.Magenta
 },
 
 -- Main content area
 {
 id = 3,
 type = "Window", 
 title = {
 type = "Text",
 value = "◢█◣ MAIN MATRIX ◤█◥",
 foregroundColor = api.FGColors.Brights.Green,
 backgroundColor = api.BGColors.NoBrights.Black,
 style = api.TextStyle.Bold
 },
 width = "w - 4",
 height = "h - 12",
 x = 3,
 y = 7,
 border = api.BoxDrawing.HeavyBorder,
 backgroundColor = api.BGColors.NoBrights.Black
 },
 
 -- Status/info panel
 {
 id = 4,
 type = "Window",
 title = {
 type = "Text", 
 value = function()
 return "⚠ SYSTEM STATUS: ONLINE ⚠"
 end,
 foregroundColor = api.FGColors.Brights.Yellow,
 backgroundColor = api.BGColors.NoBrights.Red,
 style = api.TextStyle.Bold,
 dynamic = true
 },
 width = "w - 2",
 height = 4,
 x = 2,
 y = "h - 5",
 border = api.BoxDrawing.NoBorder,
 backgroundColor = api.BGColors.NoBrights.Red
 }
 }
 }
}

🔌 Plugin Development

Creating a Basic Plugin

-- plugins/system_monitor.lua
-- Real-time system monitoring plugin
-- the plugin lua file are returned function that accept 4 params and return VirtualTerminal object
local api = require("rmp.rmp")
-- params:
-- x,y : left top corner position (x position and y position)
-- xx,yy : right bottom corner position
-- return: 
-- VirtualTerminal
local vterm = api.VirtualTerminal.new()
return function(x, y, xx, yy)
 local w = xx - x - 1
 local h = yy - y - 1
 -- Plugin state
 local updateInterval = 1.0 -- seconds
 local lastUpdate = 0
 local systemData = {}
 
 -- Update system information
 local function updateSystemInfo()
 local currentTime = os.time()
 if currentTime - lastUpdate >= updateInterval then
 -- Get system info (simplified example)
 systemData = {
 time = os.date("%Y-%m-%d %H:%M:%S"),
 memory = "Memory: 4.2GB / 8.0GB",
 cpu = "CPU: 15.3%",
 processes = "Processes: 156"
 }
 lastUpdate = currentTime
 end
 end
 
 -- Render plugin content
 local function render()
 vterm:clear()
 updateSystemInfo()
 
 -- Header
 vterm:writeText(x, y, "═══ SYSTEM MONITOR ═══", 
 api.FGColors.Brights.Cyan)
 
 -- System information
 local line = y + 2
 for key, value in pairs(systemData) do
 vterm:writeText(x, line, value, api.FGColors.NoBrights.White)
 line = line + 1
 end
 
 -- Instructions
 vterm:writeText(x, yy - 2, "Press 'R' to refresh", 
 api.FGColors.NoBrights.Yellow)
 end
 
 -- Event handlers
 vterm:onKeyboard(function(key)
 if key == api.KEY_R then
 lastUpdate = 0 -- Force refresh
 render()
 end
 end)
 
 -- Initial render
 render()
 
 return vterm
end

Plugin Registration and Configuration

-- In your theme or main configuration
-- ~/.rmp/init.lua
return {
 -- the default configuration of the sound
 settings = {
 fps = 60,
 volume = 0.5, -- 0 to 1
 speed = 1.0, -- 0.25 to 4.0
 mode = api.PlaybackMode.ONES, -- playback modes
 restart_engine = api.KEY_CTRL_R,
 exit = api.KEY_Q,
 -- inc or dec
 inc_speed = 0.1,
 inc_volume = 0.1,
 inc_seek = 5
 },
 soundMap = {
 pause_sound = api.KEY_SPACE,
 resume_sound = api.KEY_SPACE,
 next_sound = api.KEY_N,
 prev_sound = api.KEY_P,
 vol_up = api.KEY_PLUS,
 vol_down = api.KEY_MINUS,
 seek_left = api.KEY_LEFT,
 seek_right = api.KEY_RIGHT,
 speed_up = api.KEY_UP,
 speed_down = api.KEY_DOWN,
 change_playback_mode = api.KEY_TAB
 },
 template = "<your template lua file name without extension>",
 -- plugins
 plugins = { 
 {
 -- if this attr is not nil or exists , the runner ignore activate
 themeWindowId = 2, -- the window id that the plugin injected in
 isActivated = true,-- isActivated (true activated by default otherwise is not)
 activate = api.KEY_E, -- toggle key for activation plugin
 switchPluginKey = api.KEY_I, -- switch key for multiple plugins that integrated on the same window id
 names = { -- plugins
 -- examples
 "matrix_digital_rain_effect",
 "music_waves",
 "text_editor",
 "tellme_yourname",
 "digital_clock_with_effects",
 "3d_cube",
 "filebrowser"
 }
 },
 {
 themeWindowId = 3,
 isActivated = true,
 activate = api.KEY_E,
 names = {
 "center_text"
 }
 },
 {
 isActivated = false,
 activate = api.KEY_O,
 names = {
 "other plugins"
 }
 }
 }
}

🎮 Game Development Guide

Game Engine Features

🌍 Cross-Platform Support

Supported Platforms

Terminal Compatibility

Platform-Specific Features

// Platform detection in C engine
#ifdef _WIN32
 #define PLATFORM_WINDOWS
 #define PATH_SEPARATOR "\\"
#elif defined(__APPLE__)
 #define PLATFORM_MACOS
 #define PATH_SEPARATOR "/"
#elif defined(__linux__)
 #define PLATFORM_LINUX
 #define PATH_SEPARATOR "/"
#endif

📚 Comprehensive API Reference

Core Framework Classes

api.Frame

local frame = api.Frame.new()
frame:setFps(60) -- Set target FPS (1-120)
frame:add(frame) -- Add VirtualTerminal or Frame to it
frame:run(keyEvent) -- Process single frame

api.Window

local window = api.Window.new(id)
window:createWindow(title, width, height, x, y, border, bgColor, fgColor, contentFunction)
window:setTitle(title) -- Update window title
window:resize(w, h) -- Resize window
window:move(x, y) -- Move window position

api.Terminal

api.Terminal:clear() -- Clear entire screen
api.Terminal:setCursor(x, y) -- Move cursor position
api.Terminal:hideCursor() -- Hide cursor
api.Terminal:showCursor() -- Show cursor
local key = api.Terminal:handleKey() -- Get pressed key (non-blocking)
api.Terminal:getSize() -- Get terminal dimensions

api.VirtualTerminal

local vterm = api.VirtualTerminal.new()
vterm:writeText(x, y, text, color) -- Write colored text
vterm:drawBox(x, y, w, h, border, color) -- Draw bordered box
vterm:clear() -- Clear virtual buffer
vterm:addEventListener(EventType, callback) -- Add event handler

api.Text

local text = api.Text.new(content, x, y, fgColor, bgColor, style)
text:getText() -- Update text content
text:getPosition() -- Move text position
text:getColor() -- Change text colors
text:getStyle() -- Apply text style

Audio System

api.Audio

api.Audio:load(filename) -- Load audio file
api.Audio:play() -- Start playback
api.Audio:pause() -- Pause playback
api.Audio:stop() -- Stop playback
api.Audio:setVolume(level) -- Set volume (0.0-1.0)
api.Audio:seek(position) -- Seek to position in seconds
api.Audio:getPosition() -- Get current playback position
api.Audio:getDuration() -- Get total track duration

Color Constants

Foreground Colors

-- Bright colors
api.FGColors.Brights.Black
api.FGColors.Brights.Red
api.FGColors.Brights.Green
api.FGColors.Brights.Yellow
api.FGColors.Brights.Blue
api.FGColors.Brights.Magenta
api.FGColors.Brights.Cyan
api.FGColors.Brights.White
-- Normal colors 
api.FGColors.NoBrights.Black
api.FGColors.NoBrights.Red
-- ... (similar pattern)

Background Colors

-- Background colors (similar structure)
api.BGColors.Brights.Black
api.BGColors.NoBrights.Red
-- ... etc

Colors From Hex

api.colorFromHex("ff0000" , api.FG) -- forground color
api.colorFromHex("ff0000" , api.BG) -- background color

Text Styles and Drawing

Text Styles

api.TextStyle.Normal -- Normal text
api.TextStyle.Bold -- Bold text
api.TextStyle.Italic -- Italic text
api.TextStyle.Underline -- Underlined text
api.TextStyle.Strikethrough -- Strikethrough text

Box Drawing Characters

api.BoxDrawing.NoBorder -- No border
api.BoxDrawing.LightBorder -- Light single line border
api.BoxDrawing.HeavyBorder -- Heavy single line border 
api.BoxDrawing.RoundedBorder -- Rounded corner border

Input Handling

Key Constants

-- Letter keys
api.KEY_A, api.KEY_B, ..., api.KEY_Z
-- Number keys
api.KEY_0, api.KEY_1, ..., api.KEY_9
-- Special keys
api.KEY_SPACE -- Space bar
api.KEY_ENTER -- Enter/Return
api.KEY_TAB -- Tab
api.KEY_ESC -- Escape
api.KEY_BACKSPACE -- Backspace
api.KEY_DELETE -- Delete
-- Arrow keys
api.KEY_UP -- Up arrow
api.KEY_DOWN -- Down arrow 
api.KEY_LEFT -- Left arrow
api.KEY_RIGHT -- Right arrow
-- Modifier keys
api.KEY_CTRL_A, api.KEY_CTRL_B, ... -- Ctrl combinations

check the docs from RMP Framework

🐛 Troubleshooting

Common Issues

Build Errors

# Error: Permission denied during install
# Solution: Use sudo for system installation
sudo ./install.sh install -v
# Error: gcc not found
# Solution: Install build tools
sudo apt-get install build-essential gcc

🤝 Contributing

Code Style Guidelines

Contribution Areas

Submitting Changes

Reporting Issues

📄 License

🙏 Acknowledgments

🚀 What's Next?

Upcoming Features (Roadmap)

Getting Involved