Skip to content
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

Various fixes and cleanup #14

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Various fixes and cleanup #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f449394
chore: improve some metadata stuff (fixes #2)
ashhhleyyy Jul 15, 2024
2d3367c
fix: change MoreCodecs example (fixes #12)
ashhhleyyy Jul 15, 2024
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
2 changes: 1 addition & 1 deletion docs/plasmid/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Most things here you can ignore: you only really need to worry about what's in t
- This adds a field with a given name and type that will be read from the JSON.

- You will notice that `Codec.STRING` is itself a `Codec<String>`! Every field you declare will require a Codec to describe how that field should be handled. In this case, we're indicating that the greeting field should be loaded using `Codec.STRING`. In the same way, we could reference any other codec we create to add it as a field! This is very useful in allowing combinations of codecs to create complex structures!
- Codec tip: most serializable Minecraft types will hold a static `CODEC` field for use (e.g. `BlockPos.CODEC` or `Identifier.CODEC`). If not, we bundle a `MoreCodecs` type which provides some common ones that are not included in the vanilla codebase (e.g. `MoreCodecs.TEXT`).
- Codec tip: most serializable Minecraft types will hold a static `CODEC` field for use (e.g. `BlockPos.CODEC` or `Identifier.CODEC`). If not, we bundle a `MoreCodecs` type which provides some common ones that are not included in the vanilla codebase (e.g. `MoreCodecs.URL`).

- The parameter to `.fieldOf()` specifies the name of the field (in JSON) that this value will be read from.

Expand Down
6 changes: 6 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
site_name: Nucleoid Docs
repo_url: https://github.com/NucleoidMC/nucleoid-docs
repo_name: NucleoidMC/nucleoid-docs
edit_uri: edit/main/docs/

theme:
name: material
Expand All @@ -10,6 +11,7 @@ theme:
- navigation.tabs
- navigation.sections
- toc.integrate
- content.action.edit
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
Expand All @@ -25,6 +27,8 @@ theme:
name: Switch to dark mode
icon:
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye

nav:
- index.md
Expand All @@ -49,6 +53,8 @@ extra:
link: https://github.com/NucleoidMC
- icon: fontawesome/brands/twitter
link: https://twitter.com/NucleoidMC
- icon: fontawesome/brands/mastodon
link: https://floss.social/@Nucleoid

copyright: Content on this site is licensed CC-BY-SA; excluding code snippets, which are licensed under The Unlicense.

Expand Down