diff --git a/.eslintrc.cjs b/.eslintrc.cjs index 4c99537..3f90fed 100644 --- a/.eslintrc.cjs +++ b/.eslintrc.cjs @@ -1,18 +1,8 @@ module.exports = { root: true, env: { browser: true, es2020: true }, - extends: [ - 'eslint:recommended', - 'plugin:@typescript-eslint/recommended', - 'plugin:react-hooks/recommended', - ], + extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'], ignorePatterns: ['dist', '.eslintrc.cjs'], parser: '@typescript-eslint/parser', - plugins: ['react-refresh'], - rules: { - 'react-refresh/only-export-components': [ - 'warn', - { allowConstantExport: true }, - ], - }, + rules: {}, }; diff --git a/README.md b/README.md deleted file mode 100644 index 1c970dc..0000000 --- a/README.md +++ /dev/null @@ -1,59 +0,0 @@ -# Bravy Chicky Dice Adventure - -## Description - -This is just a simple turn-based game where you just have to throw a dice, defeat the enemy, and go to the highest floor as you can. - -Help Chicky to climb up the Natural Tower by giving it a command. Chicky doesn't quite understand yet what it will do. - -There are 4 possible commands to fight the ghost defending the Natural Tower. - -By rolling the dice, you can guide Chicky with the possible commands depends on the number appeared on the dice. - -- `n == 1` Do nothing -- `n >= 2` Able to Defend -- `n >= 3` Able to Defend, and Attack -- `n >= 5` Able to Defend, Attack, and Heal - -Also, you may challenge your friends and brag your highest score. - -I haven't been ditching practicing web development these days, and I had hard time creating all these stuff. - -This game is best viewed in landscape mode. - -## Requirements - -1. Text editor (Preferred Visual Studio Code) -1. Terminal (I use the built-in terminal on Visual Studio Code) - -## Building the program - -For my future reference, below is the way to build the program. - -1. Clone the repository -1. Install the dependencies using this command: - `# npm` -1. Build the main program using this command: - `# npm run build` -1. At the step above, the distributed program will be produced, and _dist_ folder will be generated. The step from here will be optional if you want to run the program on the localhost. -1. Create a local virtual server using this command: - `# npm run dev` -1. After building, it can be accessed at [http://localhost:5173/](http://localhost:5173/). - -## Resources - -1. [Blockbench](https://www.blockbench.net/) Low poly 3D model creation tool -1. [Aseprite](https://www.aseprite.org/) Image creation software for textures -1. [ThreeJS](https://threejs.org/) 3D Rendering engine used for the game -1. [React](https://react.dev/) Front end web library for UI -1. [React Three Fiber](https://docs.pmnd.rs/react-three-fiber) Integration of ThreeJS into React -1. [GSAP](https://www.gsap.com/) Animation or tweening -1. [TailwindCSS](https://tailwindcss.com/) CSS framework for easy styling -1. [Vite](https://vitejs.dev/) Build tool for the web -1. [TypeScript](https://www.typescriptlang.org/) Type safety JavaScript transpiler -1. [NodeJS](https://nodejs.org/en/) Runtime JavaScript used for building the app -1. [npm](https://www.npmjs.com/) Package manager for NodeJS -1. [Silkscreen](https://fonts.google.com/specimen/Silkscreen) Pixel-art fonts -1. [Misaki](https://littlelimit.net/misaki.htm) Pixel-art fonts -1. [PICO-8 Secret Palette](https://lospec.com/palette-list/pico-8-secret-palette) All PICO-8 palettes and its hidden colours -1. [Visual Studio Code](https://code.visualstudio.com/) Text editor (IDE) I used for development diff --git a/index.html b/index.html index e4b78ea..4887d0c 100644 --- a/index.html +++ b/index.html @@ -4,10 +4,26 @@ -