Oscean Save

Static wiki engine written in Uxntal

Project README

Oscean

This is the repository for the Oscean wiki, see the on-site documentation for more up-to-date details. Oscean is a static site written in Uxntal, a stack-machine assembly language designed for a portable virtual machine. The database tables are stored as plain-text files designed to fit in Uxn's 64kb of memory. The main branch is the live version.

Build

The oscean.rom file can be assembled with uxnasm or drifblim.

Maeve

mkdir tmp
uxnasm src/maeve.tal bin/maeve.rom # build pre-processor

Maeve is the pre-processor, it generates temporary files for oscean to populate the wiki with. The files are as follow:

  • entry-log, contains all the diary logs for that entry.
  • entry-map, contains all the incoming links for that entry.

Oscean

uxnasm src/oscean.tal bin/oscean.rom # build wiki engine

The rom does not have a graphical interface, but can be used with the uxncli emulator:

Run

uxncli bin/maeve.rom
uxncli bin/oscean.rom

Extras

  • Pull Requests are welcome.
  • See the License file for license rights and limitations(MIT), the media assets are BY-NC-SA 4.0.
Open Source Agenda is not affiliated with "Oscean" Project. README Source: XXIIVV/oscean
Stars
471
Open Issues
14
Last Commit
1 week ago
Repository
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating