document eternal file

This commit is contained in:
Jill 2022-09-19 23:57:03 +03:00
parent c05d60853e
commit 76a6581616
2 changed files with 10 additions and 1 deletions

View File

@ -99,6 +99,7 @@ Uranium Template originally formed during the creation of a currently unreleased
- [`util`](#util)
- [`aft`](#aft)
- [`noautplay`](#noautplay)
- [`eternalfile`](#eternalfile)
- [`uwuify`](#uwuify)
- [Examples](#examples)
- [The obligatory](#the-obligatory)
@ -744,6 +745,14 @@ A single function which can be called before `uranium.ready()` to disable autopl
require('stdlib.noautoplay')()
```
### `eternalfile`
A single function which turns your file into an eternal, neverending file, until the player puts it out of its misery by exiting. The current beat will always go from 0 to 1 and start over once this is enabled.
```lua
require('stdlib.eternalfile')()
```
### `uwuify`
```lua

@ -1 +1 @@
Subproject commit ed260e9d695777c012293a58d895f0ae09fb9265
Subproject commit dcd55494a29a2986304c4ee0a79d3acf1f9fe470