Skip to content

janisdd/basic-board-game-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

basic board game editor

is a basic board game editor with some simulation capabilities (and printing)

Demo

Screenshot

usage

open the file dist/index.html in your preferred browser

(after you downloaded/cloned the project or just the dist folder)

setup

if you want to run the dev server for development or the tests you need to

cd /to/the/project/dir
npm install

running the dev server

npm run dev
# then open your browser at http://localhost:8080

on mac you might get high cpu usage even if you are not modifying anything... according to webpack/webpack#701 you need to install npm install fsevents to solve this

building

if you're on linux/mac and you got sed & echo then you can just run

npm run buildCompiler # this will build the interpreter (it's actually not a compiler but like to call is so)
npm run build         # this will build & output into ./dist

if you don't have sed & echo then you need to take some manual steps to build the compiler (actually just delete some lines in some file)

see devDocs/usingTheInterpreter.md for these steps

running tests

tests are only done for the interpreter and are written in jest

npm run test

there are still some tests missing. the tests can be found at simulation/__tests__

dev docs

the dev docs are located at ./devDocs

notes

there won't be much movement in this project (at least from me) because i have some other things/projects to do and for my board game all features are there

TODOs & issues

in ./TODO.md are issues, ideas & todos captured

some of the notable issues are

  • when a line is connected to a field anchor point then moving the field/line undo is bugged

    • this could also mess up the field connected lines list
  • printing (vars) maybe not all vars are found

  • variable check maybe not all vars are found

  • when the tile outline is displayed the drag operations (fields/lines/imgs) are slow

  • error messages are not i18n ready

Releases

No releases published

Packages

No packages published