Stephen-Gose-Game-Studio / Armoria

Heraldry generator and editor

Home Page:https://azgaar.github.io/Armoria

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Armoria

Armoria is a procedural heraldry generator and editor by Azgaar. It's both a separate serverless GUI tool and server-side API. The same logic is also available as a part of the Fantasy Map Generator project.

Armoria is under development, the GUI version is available on Github Pages.

Gallery View Editor View

Join our Reddit community and Discord server to share your creations, discuss the Tool, suggest ideas and get the most recent updates. You can support the project on Patreon.

For Developers

The tool is almost zero-dependency vanilla JS with just Svelte to build GUI. Svelte is a bit specific framework that compiles components to vanilla JS.

I am not a profi in web-development or Svelte, so help from professional developers and Pull Requests are welcomed.

Installation

Clone the repository and install the dependencies.

git clone https://github.com/Azgaar/Armoria.git
cd Armoria
npm install

Usage

Run dev to start Rollup and build in dev mode

npm run dev

Navigate to localhost:5000. You should see the app running.

Edit a component file in src, save it, and reload the page to see your changes.

To create an optimised version of the app run:

npm run build

API

Armoria API is available as a seperate project, see the documentation. The API allows to GET random or predefined vector and raster heraldic images of a given size.

License

The code is distributed under MIT.

Simple svg shapes and charges are self-made and available under CC0. Complex charges are historical, svg renders are coming from WappenWiki and available for non-commercial use under CC3. Source info is added to svg files as a comment.

All images are manually optimized by me.

About

Heraldry generator and editor

https://azgaar.github.io/Armoria


Languages

Language:Svelte 50.6%Language:JavaScript 40.3%Language:HTML 8.2%Language:CSS 0.8%Language:Batchfile 0.0%