https://github.com/yhdgms1/novely
Create interactive stories with ease
https://github.com/yhdgms1/novely
browser-based-game engine game game-engine game-engines interactive-storytelling javascript novel solid-js text-based-adventure typescript visual visual-novel visual-novel-engine visual-novels web
Last synced: 2 months ago
JSON representation
Create interactive stories with ease
- Host: GitHub
- URL: https://github.com/yhdgms1/novely
- Owner: yhdgms1
- License: isc
- Created: 2023-02-07T08:29:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-01T06:02:44.000Z (3 months ago)
- Last Synced: 2025-03-04T23:41:52.826Z (3 months ago)
- Topics: browser-based-game, engine, game, game-engine, game-engines, interactive-storytelling, javascript, novel, solid-js, text-based-adventure, typescript, visual, visual-novel, visual-novel-engine, visual-novels, web
- Language: TypeScript
- Homepage: https://novely.deno.dev
- Size: 22.7 MB
- Stars: 26
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: license
Awesome Lists containing this project
README
# [Novely](https://novely.deno.dev)
Novel Engine for creating interactive stories
- **Multilanguage**: Enable users to access content in multiple languages and handle pluralization in a simple and intuitive way
- **TypeScript**: Development with efficiency, type checking, and smart auto complete
- **Modularity in Mind**: Opt-in features, instead of opting-out! Lightweight and highly customizable
## Community
We have a [Discord](https://discord.gg/h2U63hx4GR) server and a [Telegram](https://t.me/novelyjs) chat
## Demo
You can see working demo [here](https://novely-demo.deno.dev/)
## Documentation and Getting Started
You can find documentation on the [website](https://novely.deno.dev/guide/getting-started.html).
## Examples
```ts
import { createSolidRenderer } from '@novely/solid-renderer';
import { novely, EN } from '@novely/core';
const engine = novely({
renderer: createSolidRenderer().renderer,
translation: {
en: {
internal: EN
}
},
characters: {
Natsuki: {
name: 'Natsuki',
color: '#f388aa',
emotions: {
happy: './natsuki-happy.png'
}
}
}
});
engine.script({
start: [
engine.action.showBackground('./school.png'),
engine.action.showCharacter('Natsuki', 'happy'),
engine.action.dialog('Natsuki', 'Whoa! I am very happy to see you!')
]
})
```
## Donations
Your support is appreciated! You can make a donation to help keep this project alive:
- **Toncoin (TON):** `UQDP7u4ZgCkNkk4jGcTkhmlWl6pXtXoJZpCUAH7pj_BDWjpZ`
- **Tether (USDT-TRC20):** `TW3nWLvz6zQLg4SRLdLxfj2Qt4KoH248aW`
## License
Novely is [ISC licensed](https://github.com/yhdgms1/novely/blob/main/license).