Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
6630a55
monolithic lua API, working on styling and usability
SlashScreen Sep 8, 2025
4dd450c
More maintainable templates. Now... analysis and toc
SlashScreen Sep 9, 2025
f5f5c6d
added permalinks
SlashScreen Sep 9, 2025
87651e8
got the arrows to display inline
SlashScreen Sep 9, 2025
3d4e291
with great strife I have generated a TOC
SlashScreen Sep 9, 2025
27385a9
ok got permalinks working well enough
SlashScreen Sep 9, 2025
685019c
toc style pass
SlashScreen Sep 9, 2025
f9e0c02
added type backlinking
SlashScreen Sep 10, 2025
4801a9c
Added TOCs to the other generated pages, fixed links I hope
SlashScreen Sep 10, 2025
7dc085e
remove ruby stuff. dorry badosu
SlashScreen Sep 10, 2025
67b9645
lining up and polish
SlashScreen Sep 10, 2025
3200cdf
Fixed backlinks enough, supporting generics I think?
SlashScreen Sep 14, 2025
379bdb6
fixed a lot of bugs
SlashScreen Sep 14, 2025
99d3e53
fixed a bunch of spacing issues
SlashScreen Sep 14, 2025
97af4ed
used styles instead
SlashScreen Sep 15, 2025
f00ea1a
working on getting CI to work
SlashScreen Sep 15, 2025
0f30a3d
Merge branch 'master' into site_formatting_template
SlashScreen Sep 16, 2025
41c2d49
fixed type linking. kind of a bandaid solution. If it doesn't work ag…
SlashScreen Sep 16, 2025
724867c
Merge branch 'site_formatting_template' of github.com:SlashScreen/Rec…
SlashScreen Sep 16, 2025
2bc0cfc
tweaks 1
SlashScreen Sep 17, 2025
9f9122b
removed duplicate property and type tables
SlashScreen Sep 17, 2025
662e5c3
more link fixes, added the permalink bump thing
SlashScreen Sep 17, 2025
54738a3
type renderign works, now permalinks
SlashScreen Sep 21, 2025
804079f
rethinking how globals are generated
SlashScreen Sep 23, 2025
45bd1a3
side quest: promote forum
SlashScreen Sep 23, 2025
4e7e056
1st draft of refactor. probably extremely broken
SlashScreen Sep 24, 2025
e72f2ae
working through bugs
SlashScreen Sep 25, 2025
1c66bdc
ironing out more bugs
SlashScreen Oct 2, 2025
011b359
ok maybe wasn't the right approach
SlashScreen Oct 3, 2025
81f3999
complete structural rethinking. see will be difficult. Have a few bugs
SlashScreen Oct 9, 2025
d9b3802
added method support
SlashScreen Oct 9, 2025
e399859
fixed types
SlashScreen Oct 9, 2025
c8cfde4
ok see kinda works now
SlashScreen Oct 11, 2025
5d148e4
formatting changes
SlashScreen Oct 11, 2025
b4ea30e
bump emmylua version
SlashScreen Oct 16, 2025
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
6 changes: 2 additions & 4 deletions .github/workflows/publish-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ env:
EMMYLUA_DOC_CLI_VERSION: "0.8.2"
JQ_VERSION: "1.8.0"
7Z_VERSION: "24.09"
RUBY_VERSION: "3.3"
MISE_ENV: "ci"
jobs:
build:
Expand Down Expand Up @@ -48,8 +47,7 @@ jobs:
path: |
${{ runner.temp }}/hugo_cache
key: hugo-${{ github.run_id }}
restore-keys:
hugo-
restore-keys: hugo-
- name: Configure Git
run: git config core.quotepath false
- name: Setup Pages
Expand All @@ -66,7 +64,7 @@ jobs:
HUGO_ENVIRONMENT: production
working-directory: ./doc/site
run: |
mise run lua_pages
mise run lua_json
mise run binary_pages
mise exec hugo -- \
hugo \
Expand Down
92 changes: 77 additions & 15 deletions doc/site/assets/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.col-span-1 {
grid-column: span 1 / span 1;
grid-column: span 1 / span 1;
}

.grid-cols-2 {
Expand Down Expand Up @@ -27,7 +27,7 @@
}

.mt-05 {
margin-top: .5rem !important;
margin-top: 0.5rem !important;
}

.mt-1 {
Expand All @@ -43,7 +43,7 @@
}

.pl-025 {
padding-left: .25rem;
padding-left: 0.25rem;
}

.pl-1 {
Expand All @@ -55,13 +55,19 @@
}

.content.lua-api {
h2, h3, h4 {
h2,
h3,
h4 {
margin-top: 1rem !important;
margin-bottom: .5rem !important;
margin-bottom: 0.5rem !important;
}

h5, h6, p, ul, .hextra-code-block {
margin-top: .5rem !important;
h5,
h6,
p,
ul,
.hextra-code-block {
margin-top: 0.5rem !important;
}

p {
Expand All @@ -75,23 +81,79 @@
dl {
}

dt, dd, li {
margin-top: .25rem !important;
dt,
dd,
li {
margin-top: 0.25rem !important;
}

dd, li {
margin-bottom: .25rem !important;
dd,
li {
margin-bottom: 0.25rem !important;
}

dt, dd {
dt,
dd {
margin-bottom: 0 !important;
}

.hextra-code-block {
pre {
margin-bottom: .5rem !important;
padding: .5rem !important;
border-radius: .4rem !important;
margin-bottom: 0.5rem !important;
padding: 0.5rem !important;
border-radius: 0.4rem !important;
}
}
}

.api-card-toplevel {
background-color: #303030;
padding: 1rem;
margin-bottom: 1rem;
margin-top: 1rem;
border-radius: 1rem;
box-shadow: 0 0 1rem rgb(17, 17, 17);
}

.api-card {
padding: 1rem;
margin-bottom: 1rem;
margin-top: 1rem;
border-radius: 1rem;
background-color: #222222;
}

.display-inline {
display: inline;
}

.margin-left-1rem {
margin-left: 1rem;
}

.list-style-type-none {
list-style-type: none;
}

.margin-top-half-rem {
margin-top: 0.5rem;
}

.generated-toc-scroll-box {
overflow-y: scroll;
height: 100%;
}

.generated-toc-sticky {
position: sticky;
top: 7vh;
height: 85vh;
}

.width-25vw {
width: 25vw;
}

.margin-left-dot8rem {
margin-left: 0.8rem;
}
8 changes: 5 additions & 3 deletions doc/site/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ draft = false
{{< /cards >}}
{{< cards >}}
{{< card title="Tech Annihilation" image="/showcase/ta.jpeg" link="https://github.com/techannihilation/TA" >}}
{{< card title="SplinterFaction" image="showcase/splinter_faction.jpg" link="splinterfaction.info" >}}
{{< card title="Splinter Faction" image="showcase/splinter_faction.jpg" link="https://splinterfaction.info/" >}}
{{< card title="Mechcommander: Legacy" image="/showcase/mcl.jpg" link="https://github.com/SpringMCLegacy/SpringMCLegacy/wiki" >}}
{{< /cards >}}

Expand All @@ -37,8 +37,9 @@ Want to know if recoil is right for your project? [Find out here](articles/choos

The best place to get started is our [getting started](docs/guides/getting-started/) section. There are other sources, though:

- [Forum] Got a question? ask us here!
- [Spring Wiki] (For information not yet ported to the docs)
- [Recoil Github Wiki]
- [Recoil Github Wiki] (for engine dev-related information not yet ported to the docs)
- [Discord server]

### Download
Expand All @@ -53,7 +54,7 @@ See [Development](development) for guides on how to build and
develop Recoil.

When contributing to this repository, please first discuss the change you wish
to make via [GitHub issues], our [Discord server] or any other method with the
to make via [GitHub issues], our [Forum], our [Discord server], or any other method with the
owners of this repository before making a change.

### Thank you to the contributors of Recoil!
Expand All @@ -65,3 +66,4 @@ owners of this repository before making a change.
[Discord server]: https://discord.gg/GUpRg6Wz3e
[Spring Wiki]: https://springrts.com/wiki/Main_Page
[Recoil Github Wiki]: {{% param "repo" %}}wiki
[Forum]: https://github.com/beyond-all-reason/RecoilEngine/discussions/categories/general
1 change: 1 addition & 0 deletions doc/site/content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title = 'Recoil Reference'
date = 2025-05-08T00:04:56-07:00
draft = false
layout = "list"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't find this layout.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should have been part of the original theme, but it didn't work, and I will have to revisit it

[cascade]
[cascade.params]
type = "docs"
Expand Down
4 changes: 2 additions & 2 deletions doc/site/content/docs/guides/migrating-from-spring.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ migrating from Spring.
Rendering fonts now obeys GL color state. This means that sometimes text will
not be the same color as previously. To get back previous behaviour, you might
need to add
[`gl.Color`]({{% ref "docs/lua-api/globals/GL#gl.Color" %}})
[`gl.Color`]({{% ref "docs/lua-api/#gl.Color" %}})
in front of
[`gl.Text`]({{% ref "docs/lua-api/globals/GL#gl.Text" %}})
[`gl.Text`]({{% ref "docs/lua-api/#gl.Text" %}})
calls. Alternatively, you can add inline colour codes (`\255\rrr\ggg\bbb`).

### Spring.Marker usage
Expand Down
2 changes: 1 addition & 1 deletion doc/site/content/docs/guides/rendering/making-shaders.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ layout(std140, binding = 1) uniform UniformParamsBuffer {
};
```

To include this in your shader, it's better to append this to the beginning of your shader on the lua side with [`gl.GetEngineUniformBuffer()`]({{% ref "docs/lua-api/gl/#glgetengineuniformbufferdef" %}}), like `fragment = VFS.LoadFile("path/to/shader.frag.glsl"):gsub("//##UBO##", gl.GetEngineUniformBuffer())`. We use the gsub here to put UBO in the middle of the code, rather than just prepend engine UBO in front of the shader, to make sure it's after the `#version` stuff glsl expects to be at the beginning. If you plan to use them in your shader, make sure to add `//##UBO##` as a comment up near the beginning. This way, if something changes, you won't have to update all of your scripts (but we will still have to update this article).
To include this in your shader, it's better to append this to the beginning of your shader on the lua side with [`gl.GetEngineUniformBuffer()`]({{% ref "docs/lua-api/#glgetengineuniformbufferdef" %}}), like `fragment = VFS.LoadFile("path/to/shader.frag.glsl"):gsub("//##UBO##", gl.GetEngineUniformBuffer())`. We use the gsub here to put UBO in the middle of the code, rather than just prepend engine UBO in front of the shader, to make sure it's after the `#version` stuff glsl expects to be at the beginning. If you plan to use them in your shader, make sure to add `//##UBO##` as a comment up near the beginning. This way, if something changes, you won't have to update all of your scripts (but we will still have to update this article).

### Custom Uniforms

Expand Down
4 changes: 3 additions & 1 deletion doc/site/content/docs/lua-api/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
+++
title = "Lua API Reference"
layout = "lua_api"
tableOfContents = true
+++

If you're seeing this page, the lua pages were not built from source.
If you're seeing this page, the lua page/api data was not generated properly.

If you wish to change how this page is displayed, see `doc/site/docgen`
Loading