README.md

WaveProject

Project Wave is a 2D platformer, pixel-art based game written in TS, HTML and CSS. The main goal of the game is to familiarise future University of Lodz's students with perks and points of interests of each faculty in an enganing, user-friendly manner.

The project was build by Kamila, Krzysztof and Mikołaj in collaboration with University of Lodz's Communication and PR Centre.
The in-game platformer music is provided by lofi_hubi.

Live build

The game can be played here - let us know what you think!

Screenshots

Developer info

Implementation

App.ts <- views/RoomView.ts as RoomView

App.ts <- views/GameView.ts as GameView <- comp/Game.ts as GameEngine <- comp/modules/*.ts

Project structure

static:

src/                    - project source
    assets/                 - code: css (pics, fonts); media-files: pics, sounds;
    js/                     - code source
        comp/                   - components classes (game, board, etc.)
            modules/                - game modules classes
        views/                  - rendering html
        helpers.ts              - commonly used methods
    App.ts                  - App initialization
    index.html              - html initialization
webpack.config.js       - code bundler config
webpack.development.js  - development config
webpack.production.js   - production config
tsconfig.json           - typescript compiler
package.json            - npm setup file

dynamic:

node_modules/       - npm generated modules
package-lock.json   - npm generated modules file

others:

.git/
.github/
.husky/
.vscode/
tests/
.eslintrc
.gitattributes
.gitignore
.prettierrc
.swcrc
LICENCE.txt
README.md