Skip to content
This repository was archived by the owner on Jun 17, 2025. It is now read-only.

feat(README.md): add multi-language support with localization service… #19

Merged
tgiachi merged 1 commit into from
May 16, 2025
Merged

feat(README.md): add multi-language support with localization service… #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 128 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ PrimaUO is a modern Ultima Online server implementation written in C# (.NET 9.0)
- 📈 Built-in metrics and diagnostics
- 🔧 Extensible through JavaScript scripting system
- 🌐 REST API for integration with external tools
- 🌍 Multi-language support with localization services
- 💾 Automatic world saving system
- 🧰 Modern UOP file format support

## Scripting System

Expand All @@ -27,73 +30,91 @@ PrimaUO includes a powerful JavaScript scripting engine that allows you to exten
### Example Script

```javascript
// server_startup.js
// bootstrap.js
// This script is executed when the server starts

// Import script modules
const events = require("events");
const commands = require("commands");
const timers = require("timers");
const scheduler = require("scheduler");
// Import script modules are automatically registered by the server
// Log a message to the server console
console.Log("Server startup script loaded!");

// Listen for server started event
events.OnStarted(() => {
console.log("Server has started successfully!");
logger.Info("Server has started successfully!");

// Register admin commands
commands.RegisterConsoleCommand(
"announce",
"Broadcasts a message to all players",
(args) => {
// Implementation of the announce command
const message = args.join(" ");
console.log(`Broadcasting message: ${message}`);
logger.Info(`Broadcasting message: ${message}`);
// Actual broadcast implementation would go here
return true;
},
["broadcast", "shout"],
"Console",
"Admin"
CommandType.ALL,
CommandPermissionType.ADMIN
);

// Create a recurring task to run every 5 minutes
scheduler.ScheduleTask(
"cleanup",
300, // seconds
() => {
console.log("Running scheduled cleanup task...");
logger.Info("Running scheduled cleanup task...");
// Cleanup logic would go here
}
);

// Register an event handler for character creation
events.OnCharacterCreated((args) => {
console.log(`New character created: ${args.Name}`);
logger.Info(`New character created: ${args.Name}`);

// Start a delayed welcome timer
timers.OneShot("welcome_message", 10, () => {
console.log(`Sending welcome message to ${args.Name}`);
logger.Info(`Sending welcome message to ${args.Name}`);
// Actual welcome message code would go here
});
});

// Register custom item
items.Register("enchanted_sword", {
ItemId: 3937,
Name: "Enchanted Longsword",
GraphicId: 0x0F60,
Weight: 4.0,
Layer: Layer.ONE_HANDED,
Amount: 1,
Damage: {
Min: 10,
Max: 25,
Type: "Slashing"
}
});
});
```

### Available Script Modules

- **events**: Subscribe to server events
- **commands**: Register custom commands
- **timers**: Create one-time or repeating timers
The scripting API exposes the following modules:

- **logger**: Functions for logging at different levels (Info, Debug, Warn, Error, Critical)
- **events**: Subscribe to server events like OnStarted, OnUserLogin, OnCharacterCreated
- **scheduler**: Schedule tasks to run periodically
- **template**: Add variables for template rendering
- **files**: Include other script files
- **template**: Add variables for template rendering and text processing
- **files**: Include other script files or directories
- **timers**: Create one-time or repeating timers with delays
- **items**: Register custom items with properties and behaviors
- **console**: Log messages to the console or prompt for input
- **commands**: Register custom commands for console or in-game use

## Project Structure

- **Prima.Core.Server**: Core server infrastructure
- **Prima.Network**: Network layer and packet handling
- **Prima.Server**: Main server application
- **Prima.UOData**: Ultima Online data structures and utilities
- **Prima.JavaScript.Engine**: JavaScript scripting engine for server extensibility
- **Prima.Tcp.Test**: TCP testing utilities

## Getting Started
Expand All @@ -105,22 +126,48 @@ events.OnStarted(() => {

### Configuration

Configuration is handled through YAML files located in the `configs` directory:
Configuration is handled through YAML files located in the `configs` directory. Here's an example configuration:

```yaml
Prima:
Server:
Shard:
Name: "Prima Shard"
UoDirectory: "/path/to/uo/files"
MaxPlayers: 1000
TcpServer:
Host: ""
LoginPort: 2593
GamePort: 2592
EnableWebServer: true
WebServerPort: 23000
LogPackets: true
debug:
save_raw_packets: false
process:
pid_file: server.pid
process_queue:
max_parallel_task: 2
shard:
max_players: 1000
uo_directory: /path/to/uo/files
client_version:
name: Prima Shard
admin_email: admin@primauo.com
url: https://github.com/tgiachi/prima
time_zone: 0
language: en
autosave:
interval_in_minutes: 5
jwt_auth:
issuer: Prima
audience: Prima
secret: YourSecretKey
expiration_in_minutes: 44640
refresh_token_expiry_days: 1
accounts:
is_registration_enabled: true
smtp:
host: localhost
port: 25
username: ''
password: ''
use_ssl: false
use_start_tls: false
tcp_server:
host: ''
login_port: 2593
game_port: 2592
enable_web_server: true
web_server_port: 23000
log_packets: true
```

### Building from Source
Expand Down Expand Up @@ -155,6 +202,53 @@ The server includes a Swagger UI for API documentation available at:
http://localhost:23000/swagger
```

## Type Definitions for Scripts

The server automatically generates TypeScript definitions for the scripting API in `scripts/index.d.ts`, which provides autocomplete and type checking when using an editor like Visual Studio Code:

```typescript
/**
* prima v0.15.4.0 JavaScript API TypeScript Definitions
* Auto-generated documentation on 2025-05-16 10:46:15
**/

// Constants
declare const APP_NAME: string;
declare const VERSION: string;

// Modules
declare const logger: {
Info(Message: string, Args: any[]): void;
Warn(Message: string, Args: any[]): void;
Error(Message: string, Args: any[]): void;
Critical(Message: string, Args: any[]): void;
Debug(Message: string, Args: any[]): void;
};

declare const events: {
OnStarted(Action: () => void): void;
HookEvent(EventName: string, EventHandler: (arg: any) => void): void;
OnUserLogin(Action: (arg: IUserLoginContext) => void): void;
OnCharacterCreated(Action: (arg: ICharacterCreatedEventArgs) => void): void;
};

// ... and other module definitions
```

### Help Wanted!
I'm actively seeking developers to join the PrimaUO project!
This project aims to modernize Ultima Online and keep this legendary MMORPG alive for future generations. Whether you're skilled in C#, JavaScript, network programming, or game development, your contributions can make a difference.
Why join us:

Work on preserving gaming history
Modernize a classic MMORPG with cutting-edge technologies
Join a passionate community of UO enthusiasts
Gain experience with .NET 9.0, modern architecture patterns, and game server development

No previous Ultima Online development experience is required - just enthusiasm and a willingness to learn. If you're interested in contributing, please reach out via GitHub issues or discussions.
Together, we can ensure Ultima Online continues to thrive for years to come!


## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.
Expand All @@ -173,4 +267,4 @@ This project is licensed under the MIT License - see the LICENSE file for detail

- The Ultima Online community
- [ModernUO](https://github.com/modernuo/modernuo) for inspiration and some utility code
- [Orion](https://github.com/tgiachi/orion) for the server foundation framework
- [UOX3](https://github.com/UOX3DevTeam/UOX3) for inspiration
Loading