Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AlecTroemel/junk-drawer
A collection of random tools for gamedev.
https://github.com/AlecTroemel/junk-drawer
Last synced: 16 days ago
JSON representation
A collection of random tools for gamedev.
- Host: GitHub
- URL: https://github.com/AlecTroemel/junk-drawer
- Owner: AlecTroemel
- License: mit
- Created: 2021-03-25T21:47:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-29T03:02:46.000Z (6 months ago)
- Last Synced: 2024-02-23T17:34:50.034Z (4 months ago)
- Language: Janet
- Size: 229 KB
- Stars: 12
- Watchers: 5
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-stars - AlecTroemel/junk-drawer - A collection of random tools for gamedev. (Janet)
README
[](https://github.com/AlecTroemel/junk-drawer/actions/workflows/main.yml)
Everyones got one (usually somewhere in the kitchen). __Junk Drawer__ is a collection of tools & utils for developing games in the wonderful [Janet Lang](https://janet-lang.org).
```bash
[sudo] jpm install https://github.com/AlecTroemel/junk-drawer
```
### Contents:
- `ecs`: A sparse set based Entity Component System.
- `directed graph`: graph implementation with path finding function.
- `vectors`: common 2d vector functions.
- `fsm`: Finite(ish) State Machine (built off of directed graph).
- `gamestate`: Easy gamestate management (built off of directed graph).
- `timers`: Delayed & Scheduled functions (requires using ECS).
- `messages`: Communication between systems (requires using ECS).
- `tweens`: Some common tweening functions and a way to interpolate components with them (mostly requires ECS).
- `envelopes`: Multi stage tweens from the world of music (built off of directed graph and tweens).
Here's an obligitory example that uses most the stuff here.
```janet
(use junk-drawer)
(fsm/define
colors
(fsm/state :green)
(fsm/transition :next :green :yellow)
(fsm/state :yellow)
(fsm/transition :next :yellow :red)
(fsm/state :red)
(fsm/transition :next :red :yellow))
(def-tag next-color)
(def-component-alias position vector/from-named)
(def-system colored-printer
{color-fsms [:colors]}
(each [c] color-fsms
(printf "current color: %q" (c :current))))
(def-system colored-switcher
{wld :world
msgs [:message :next-color]
color-fsms [:colors]}
(when (> (length msgs) 0)
(each [msg] msgs
(each [c] color-fsms
((msg :content) c))
(messages/consume msg))))
(def GS (gamestate/init))
(gamestate/def-state example
:name "Example Gamestate"
:world (create-world)
:init (fn [self]
(let [world (get self :world)]
(add-entity world (colors :green)
(position :x 1 :y 2))
(add-entity world (colors :red))
(register-system world timers/update-sys)
(register-system world messages/update-sys)
(register-system world colored-printer)
(register-system world colored-switcher)
(timers/every world 4
(fn [wld dt]
(messages/send wld :next next-color)))
(timers/after world 7
(fn [wld dt]
(messages/send wld :next next-color)))))
:update (fn [self dt]
(:update (self :world) dt)))
(:add-state GS example)
(:goto GS :example)
(for i 0 20
(:update GS 1))
```
Each module, and most of the public functions, have detailed doc strings for your reading.
```janet
(doc junk-drawer)
(doc junk-drawer/ecs)
(doc junk-drawer/ecs/def-component)
```
If you're looking for more complete examples...check out the `examples/` folder!