Skip to content

Commit

Permalink
the dreaded conflict ops
Browse files Browse the repository at this point in the history
  • Loading branch information
deltanedas committed Dec 19, 2023
2 parents e9cdd5b + a06ff53 commit c808ae7
Show file tree
Hide file tree
Showing 27 changed files with 1,248 additions and 177 deletions.
2 changes: 2 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ warning-policy = "ignore" # false-positives like hell with absolute links & late
"/en/hosting/SS14-Admin/index.html" = "/en/server-hosting/setting-up-ss14-admin.html"
"/en/hosting/robust-cdn/index.html" = "/en/server-hosting/setting-up-robust-cdn.html"
"/en/hosting/oauth/index.html" = "/en/server-hosting/oauth.html"
"/en/hosting/port-forwarding/index.html" = "/en/server-hosting/port-forwarding.html"
"/en/technical-docs/acronyms-and-nomenclature/index.html" = "/en/general-development/codebase-info/acronyms-and-nomenclature.html"
"/en/getting-started/engine-changes/index.html" = "/en/general-developmnet/codebase-info/prs-with-engine-changes.html"
"/en/getting-started/debugging-tools/index.html" = "/en/general-development/tips/debugging-tools.html"
Expand Down Expand Up @@ -117,3 +118,4 @@ warning-policy = "ignore" # false-positives like hell with absolute links & late
"/en/engine/lighting-fov/index.html" = "/en/robust-toolbox/rendering/lighting-and-fov.html"
"/en/engine/sprites-icons/index.html" = "/en/robust-toolbox/rendering/sprites-and-icons.html"
"/hosting/hub-rules/index.html" = "/en/community/space-wizards-hub-rules.html"
"/en/hosting/hub-rules/index.html" = "/en/community/space-wizards-hub-rules.html"
13 changes: 12 additions & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ General Development
- [Codebase Organization](en/general-development/codebase-info/codebase-organization.md)
- [Acronyms & Nomenclature](en/general-development/codebase-info/acronyms-and-nomenclature.md)
- [Tips](en/general-development/tips.md)
- [Beginner FAQ](en/general-development/tips/beginner-faq.md)
- [Troubleshooting FAQ](en/general-development/tips/troubleshooting-faq.md)
- [Debugging Tools](en/general-development/tips/debugging-tools.md)
- [PRs With Engine Changes](en/general-development/tips/prs-with-engine-changes.md)
Expand Down Expand Up @@ -117,12 +118,17 @@ Space Station 14

Design Proposals
================

----------------------

- [Anomaly cores](en/proposals/anomaly-cores.md)
- [PDA messaging](en/proposals/pda-messaging.md)
- [Plant genetics](en/proposals/deltanedas-plant-genetics.md)
- [Security Genpop Rework](en/proposals/genpop_security.md)
- [Game Director](en/proposals/game-director.md)
- [Grid Inventory](en/proposals/grid-inventory.md)
- [Exterminator](en/proposals/deltanedas-exterminator.md)

----------------------

Server Hosting
==============
Expand All @@ -136,6 +142,8 @@ Server Hosting
- [Setting up SS14.Changelog](en/server-hosting/setting-up-ss14-changelog.md)
- [Setting up SS14.Watchdog](en/server-hosting/setting-up-ss14-watchdog.md)
- [OAuth](en/server-hosting/oauth.md)
- [Maintenance]()
- [Debugging server lockups](en/server-hosting/maintenance/debugging-server-lockups.md)

Other Projects
==============
Expand Down Expand Up @@ -178,6 +186,9 @@ Maintainer Meetings
==============

----------------------
- [2023-12-16](en/maintainer-meetings/maintainer-meeting-2023-12-16.md)
- [2023-11-25](en/maintainer-meetings/maintainer-meeting-2023-11-25.md)
- [2023-10-21](en/maintainer-meetings/maintainer-meeting-2023-10-21.md)
- [2023-09-23](en/maintainer-meetings/maintainer-meeting-2023-09-23.md)
- [2023-09-09](en/maintainer-meetings/maintainer-meeting-2023-09-09.md)
- [2023-09-02](en/maintainer-meetings/maintainer-meeting-2023-09-02.md)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/en/assets/images/grid-inventory/in-game.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/en/assets/images/hosting/scsi-while-true.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/en/assets/images/hosting/windbg-open.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 11 additions & 7 deletions src/en/general-development/codebase-info/conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,10 +133,10 @@ This is so it is clear to others what it is. This is especially true if the same
## Prototypes

### Prototype data-fields
Don't cache prototypes, use prototypeManager to index them when they are needed. You can store them by their ID. When using data-fields that involve prototype ID strings, use custom type serializers. For example, a data-field for a list of prototype IDs should use something like:
Don't cache prototypes, use prototypeManager to index them when they are needed. You can store them by their ID. When using data-fields that involve prototype ID strings, use ProtoId<T>. For example, a data-field for a list of prototype IDs should use something like:
```csharp=
[DataField("exampleTypes", customTypeSerializer: typeof(PrototypeIdListSerializer<ExamplePrototype>))]
public List<string> ExampleTypes = new();
[DataField]
public List<ProtoId<ExamplePrototype>> ExampleTypes = new();
```

### Enums vs Prototypes
Expand All @@ -155,7 +155,7 @@ When specifying sound data fields, use `SoundSpecifier`.
<summary>C# code example (click to expand)</summary>

```csharp=
[DataField("sound", required: true)]
[DataField(required: true)]
public SoundSpecifier Sound { get; } = default!;
```

Expand Down Expand Up @@ -190,7 +190,7 @@ When specifying sprite or texture data fields, use `SpriteSpecifier`.
<summary>C# code example (click to expand)</summary>

```csharp=
[DataField("icon")]
[DataField]
public SpriteSpecifier Icon { get; } = SpriteSpecifier.Invalid;
```

Expand All @@ -200,10 +200,14 @@ public SpriteSpecifier Icon { get; } = SpriteSpecifier.Invalid;
<summary>YAML prototype example (click to expand)</summary>

```yml=
# You can specify a specific texture file like this
# You can specify a specific texture file like this, /Textures/ is optional
- type: MyComponent
icon: /Textures/path/to/my/texture.png
# /Textures/ is optional and will be automatically inferred, however make sure that you don't start the path with a slash if you don't specify it
- type: MyComponent
icon: path/to/my/texture.png
# You can specify an rsi sprite like this
- type: MyOtherComponent
icon:
Expand Down
Loading

0 comments on commit c808ae7

Please sign in to comment.