monorepo

README

🌊 Raiment Studios monorepo

See the Raiment Studios guide or jump to a particular project below:

Projects

• Structure
  • Raiment Studios - guidelines on this project and organization
• Galthea
  • Snowfall - voxel-based adventure game
• Sea
  • sea-board - a GitOps-based, Miro-like app
  • sea-book - a hybrid book/wiki generator
  • sea-db - a toy database
  • sea-fps - a simple first-person shooter style game
  • sea-lang - a toy programming language
  • sea-platformer - a simple 2D platformer game
  • sea-notepad - a text editor
  • sea-os - a toy operating system
  • sea-outline - a GitOps-based outliner like Workflowy or Dynalist
  • sea-raytracer - a toy raytracer
  • sea-todo - a simple todo app
  • sea-zelda - simple original-Zelda-like game
  • sea-jsx - app for quickly prototyping React Components
  • sea-tsx - app for quickly prototyping React Components in TypeScript
  • sea-jest - wrapper on Jest to avoid config file clutter
• Adventure - voxel-based, open-world adventure rpg
  • Text Engine - toy text-based RPG
  • Storytelling - computer-aided 'pen & paper' storytelling procedural rpg
  • Graham's Quest - a simple 2D, tile-based implementation
  • Snow Globe - a single-region, 'snow globe' voxel-based world
  • Rivia - a 2.5D/3D voxel-based world
  • Jaskier's Tale - a fully dynamic 3D voxel-based world
• Worldbuilding - open-content for the game world of Galthea
  • Rulebook
  • Encyclopedia
  • Novel
  • Short stories
  • Concept art
  • Assets
• Libraries
  • Core - general utilities used across projects
  • Engine - the game engine tailored to Raiment's voxel world
  • React-Ex - React utilities & extensions used across projects
• Website
  • raiment-studios.github.io - public website (view)

Technology / Architecture

The preferred technologies in the monorepo are Rust, Go, JavaScript, and WASM. Currently much of the code is being fleshed out in JavaScript for rapid prototyping and easy distribution via web-based examples. As the project matures, more extensive use of Rust and WASM would be preferred.

In general, the projects prefer simple, standardized tools and formats to in order bias towards broad familiarity and easier maintenance over minor efficiency gains from specialization.

See tools for more details.

Contributing

See the Raiment Studios guide for more information about contributing, the direction of the organization, and other information about the community.

Discussion in the forums is always welcome as well.

FAQ

🚧 TODO

License

All code and content within this repository, unless specifically noted otherwise, is licensed under the MIT License.

MIT License

Copyright (c) 2022 Raiment Studios

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Unless stated explicitly otherwise, any contribution intentionally submitted for inclusion in this repository or otherwise to the project shall be licensed as stated above without any additional terms or conditions.

CHANGELOG

➕ new or improved functionality, 🗃️ internal organization or code improvements, 🛠️ defect fix, 📣 publication or release, 🧬 for sandboxes or experiments, 📚 documentation, guides, or tutorials. URL generator.

• ➕🗃️🛠️📣🧬📚

2022

• Week 44: October 31, 2022
  • TODO
• Week 43: October 24, 2022
  • TODO
• Week 42: October 17, 2022
  • TODO
• Week 41: October 10, 2022
  • TODO
• Week 40: October 03, 2022
  • TODO
• Week 39: September 26, 2022
  • TODO
• Week 38: September 19, 2022
  • TODO
• Week 37: September 12, 2022
  • TODO
• Week 36: September 05, 2022
  • TODO
• Week 35: August 29, 2022
  • 🧬 Basic Go text-engine implementation
  • 🛠️ A few sea-jsx fixes
  • 🧬 A few marketing website experiments
• Week 34: August 22, 2022
  • 🧬 Small improvements to storytelling project
• Week 33: August 15, 2022
  • 🧬 Experiments with TinyGo and WASM (mixed success)
  • ➕ Better Markdown component
  • ➕ Improve Type component options
  • ➕ sea-engine basics on shader graph / noise-heightmap
  • 🧬 voxel height map blendering
• Week 32: August 08, 2022
  • ➕ idForString to core
  • ➕ murmurHash to core
  • ➕ Markdown component to react-ex
  • ➕ MarkdownTOC component to react-ex
  • 🧬 Work on sea-engine
• Week 31: August 01, 2022
  • ➕ react-ex Button, Drawer, Flex, Type improvements
  • ➕ Added some Midjourney generated content
• Week 30: July 25, 2022
  • ➕ Add concept art assets from DALL-E 2
  • ➕ Improve flexibility of Flex component
  • ➕ Add Panel component
  • ➕ Add Type component
  • ➕ Add fs.glob to sea-jsx
  • ➕ Add fs.stat to sea-jsx
• Week 29: July 18, 2022
  • ➕ Add escapeRegEx to core
  • 🧬 Experiment with Guidebook and React data updates
• Week 28: July 11, 2022
  • ➕ Add router to ReactEx
  • 🧬 Add Sea User Guide
• Week 27: July 04, 2022
  • 🧬 Experiment with Rust + WASM
• Week 26: June 27, 2022
  • ➕ Added cat card to engine examples
• Week 25
  • ➕ sea-jsx now watches file references (in addition to source)
  • ➕ Add engine.world.generateRandomWalkablePosition()
  • 🛠️ Fix bug in LookupTable.getDerived
  • 🧬 Add first-person camera
  • ➕ Improve keyboard handling options in Engine
  • 🗃️ Move pathfinding setup into engine.world for easier reuse
  • 🧬 Add Engine User Guide docs
• Week 24
  • ➕ Add margin/padding CSS classes
  • ➕ Given sequence calls access to the engine context
  • ➕ Add place to engine.actors as rough placement method
  • ➕ Add new sprites to asset collection
  • 🧬 Add start menu experiment
  • 🧬 Add basic "card" assets/views as an experiment
• Week 23
  • 🗃️ Move to @raiment/core to fast-mersenne-twister for performance
  • 🛠️ Simplify sea-jsx glob: to return URLs only
  • ➕ Add engine goal mixin
  • ➕ Add updateInternval to Actor
  • 🛠️ Fix shadows in DayNightLighting (dist was past frustum extents)
  • ➕ Improve Layers on HeightMap actor (can include lookup tables)
  • ➕ Add components/mixins to Actor
  • 🗃️ Miscellaneous small optimizations
• Week 22
  • ➕ Cursor2D to @raiment/core
  • ➕ SimpleStats to @raiment/core
  • 🧬 Add experimental fs support to sea-jsx for faster iteration
  • ➕ Add DataReader to @raiment/core
  • 🗃️ Begin migration from mesh() to initMesh() method
  • ➕ Add VOXActor
  • ➕ Add VoxelModelSG for simple voxel mesh creation
  • ➕ Add voxel models to website assets page
• Week 21
  • 🧬 Add engine.journal
  • 🧬 Add player movement example (click -> pathfind)
  • 🧬 Add weather example (rain, snow)
  • ➕ Add engine.opt field for customization
  • 🧬 Add farming example
  • 🗂️ Rewrite path finding code for reusability
  • ➕ Add assets page to website
  • ➕ Allow StateMachine states to return Promises
  • 🧬 Add pathfinding to examples
  • 🧬 Add Forest to examples
  • ➕ Add Map3D, clamp to core
  • ➕ Add additional 32x32 sprites to the assets directory
  • ➕ Add castShadow flag
  • ➕ Add billboard flag
  • ➕ Add pinToGroundHeight flag
  • ➕ Allow env variables in glob: syntax
  • 🗃️ Create shared assets/ directory
  • ➕ Allow async mesh() Actor methods
  • ➕ Added VoxelSprite, ImageGeometryCache to engine
  • ➕ Add loadImage, getImagePixelData to `engine
  • 🧬 Added the VoxelSprite demo
  • 🧬 Experiment with glob: imports for external assets in sea-jsx
• Week 20
  • 🗃️ Clean up HeightMap actor for general reuse
  • 🧬 Add dynamic terrain updating example
  • ➕ Incorporate StateMachine into @raiment/engine Actor handling
  • 🛠️ Fix watch for .. imports in sea-jsx
  • 🛠️ Fix clean command in sea-jsx
  • ➕ Add formatNumber to @raiment/core
  • ➕ Add EngineRecorder (webm capture) component to @raiment/engine
  • ➕ Add Flex component to @raiment/react-ex
  • ➕ Add source map to sea-jsx
  • ➕ Improve sea-jsx error handling
  • ➕ Add simplex noise to @raiment/core
  • 🧬 Start sea-jsx v0.3.0
  • ➕ Update rcd to chdir to exact matches
  • ➕ Add seed, reset, shuffle to RNG
  • 📚 initial stab at some @raiment/core docs
  • 🧬 Experiment kicking off website project
  • 📚 Update tools page
• Week 19
  • ➕ Add option to bind object to StateMachine
  • ➕ Add RendererHUD to @raiment/engine for FPS
  • ➕ Add StateMachine to @raiment/engine (and example)
  • 🛠️ Fix import resolution in sea-jsx for extensions-less files
  • ➕ Add minification to sea-jsx published builds
  • ➕ Add RNG.sign() to @raiment/core
  • ➕ Add FrameLoop to @raiment/engine
  • 🛠️ Fix file watching for sea-jsx directory imports
  • ➕ Add sea-jsx support to publish to GitHub Pages
  • 🧬 Add sandbox for GitHub repo file access via web
• Week 18
  • 🗃️ Remove npm tgz packaging build and file:// references from projects
  • ➕ Add "remember last file" to sea-todo
  • ➕ sea-jsx --build now creates a single index.html with inlined JS
  • 📣 sea-todo publishes to todo.raiment.studio
• Week 17
  • 🗃️ Simplify publishing npm packages (using Codespace secrets)
  • 📚 Created CHANGELOG.md
  • 🛠️ Fix automated builds to workaround package-lock.json not liking tgz changes
  • 🗃️ Organize / improve sea-todo database code
  • ➕ Add sea-jsx watch/refresh on all referenced user files
  • ➕ Add EventEmitter to @raiment/core
• Prior to Week 17
  • 🦕