Skip to content

Add commands article and platform support article #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ikkentim merged 3 commits into from
May 16, 2026
+519 −30
Merged

Add commands article and platform support article #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d69c4a1
(wip) commands
ikkentim May 16, 2026
cff6b52
improvements
ikkentim May 16, 2026
43c2801
improvements
ikkentim May 16, 2026
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
8 changes: 5 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ This file summarizes all essential knowledge for writing correct cross-reference
```
<xref:my-unique-id>
```
- Or, for Markdown link text:
This is the **preferred** syntax.
- Alternatively, for custom Markdown link text:
```
[Link Text](xref:my-unique-id)
```
Expand All @@ -33,7 +34,8 @@ This file summarizes all essential knowledge for writing correct cross-reference
- Always check that the target file has a `uid` in its YAML frontmatter.
- Use short, descriptive UIDs (lowercase, hyphens/underscores if needed).
- Never duplicate UIDs across files.
- Prefer `xref:` links over relative links for conceptual docs when possible.
- **Prefer `<xref:uid>` syntax** over `[text](xref:uid)` for clarity and simplicity.
- Use markdown link text syntax only when you need custom link text that differs from the page title.
- For API docs, use the full type/member name as UID (e.g., `System.String`, `MyNamespace.MyClass.MyMethod`).

## 4. Troubleshooting
Expand All @@ -45,7 +47,7 @@ This file summarizes all essential knowledge for writing correct cross-reference

## 5. Example
```markdown
See [the events article](xref:events) for more details.
See <xref:events> for more details.
```

## 6. Useful Links
Expand Down
12 changes: 1 addition & 11 deletions docs/core-concepts/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,4 @@ Here's how ECS operates in practice with SampSharp:
2. open.mp fires a vehicle exit event
3. A system receives the event with the `Player` and `Vehicle` components
4. The system calculates a fare based on distance traveled and gives money to the player
5. The system logs the ride for statistics

### Benefits of ECS

The ECS pattern offers several advantages for SampSharp game mode development:

- **Flexibility** - SampSharp's domain-specific components map directly to SA-MP/open.mp concepts, making development intuitive
- **Decoupling** - Game logic (systems) is separate from data (components), making code easier to test and modify
- **Maintainability** - Each component handles a distinct aspect of a game entity, keeping concerns separated
- **Composability** - Complex entities are built by combining simpler components
- **Extensibility** - Add new systems or custom components without modifying existing code
5. The system logs the ride for statistics
Loading
Loading