Skip to content

ddhaiby/Cyber2D

Repository files navigation

cyber2d / Module

How to setup the game

Softwares

Tiled - Map Editor

Go to https://www.mapeditor.org/download.html and download the latest version.

image

Git & Git lfs

Download the .exe file from the 2 links below: https://git-scm.com/ and https://git-lfs.github.com/

image image

If you are not familiar with git, I suggest you to install TortoiseGit which is a convenient software to use. https://tortoisegit.org/download/

image

Visual Studio Code

Download and install Visual Studio Code.

https://code.visualstudio.com/download

npm

Download and install nodejs version 16.15.1

https://nodejs.org/en/download/

To double-check that npm has installed. Write npm in a console. It should display something like below. image

The game

Quick version

  • Clone the repository https://github.com/ddhaiby/Cyber2D
  • Make sure you are up-to-date with master branch
  • In a console of the root project run the following line
    • npm i
    • npm run start
  • The console should show you a link - usually http://localhost:1234/. In a browser use this link to see the game.
  • You are ready! You can now use Visual Studio code to make your change. When you save your changes, the browser page automatically refreshes so you can see and debug your work.

Long version

I) Check installation

First of all make sure TortoiseGit is correctly installed. The quickest way to check it is to right click on your file explorer and see if TortoiseGit is on the menu.

image

II) Clone the repo

On this menu, click on ''Git Clone''. You should see a menu like the image below. Make sure the URL is https://github.com/ddhaiby/Cyber2D and choose the directory to download the repository. Press OK then.

image

Once all files have been download, the project is ready to be used. The root folder should look like the image below. image

III) Open a console and initialize the game

Open a console in the root folder. One of the quickest way is to write cmd in the path text box.

image

In this console, write then run npm i and wait for the initialisation of the game. This will install everything you need to run the game. You won't need to do that again.

image

IV) Run the game

Once the initialization is done, write and run npm run start. Use the localhost link given in the console in a browser to see the game. The link is usually http://localhost:1234/.

image

You can play now ! image

About

Cyber Game Development

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published