Skip to content

Socrimoft/classic2

Repository files navigation

GitHub package.json version License: GPL v3 GitHub package.json dev/peer/optional dependency version

classic2 is an attempt at recreating Minecraft Classic with Babylon.js. It features procedural terrain generation, custom-made shader material and compute shaders, and dynamic rendering techniques.

<iframe width="560" height="315" src="https://www.youtube.com/embed/dQw4w9WgXcQ" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

A GitHub action is configured to deploy the latest version of the game online. You can access it at https://classic2.socrimoft.games/

IMPORTANT: A WebGPU-compatible browser is needed to run the game (e.g., Chrome, Edge)

Table of Contents

  1. The team
  2. Project structure and documentation
  3. How to run locally
  4. Acknowledgments

The team

Project structure and documentation

Latest documentation is available at socrimoft.github.io/classic2/ or can be made locally with the command

npm run doc

Here's how the game is organized:

classic2/
├── src/
|   ├── */                    # 
│   ├── audioManager.ts       # Class that instanciate AudioEngineV2
│   ├── inputManager.ts       # InputHandler keyboard and mouse
│   ├── loadingScreen.ts      # Class for the Loading screen
│   ├── random.ts             # Class for the seeded random function
│   └── game.ts               # Entry point of the application
├── public/                   # Static assets (e.g., textures, models, music, ...)
├── package.json              # Project dependencies and scripts
├── README.md                 # Project description (you are here)
└── tsconfig.json             # TypeScript configuration

How to run locally

Before running the project, ensure you have the following installed:

  • Node.js (v16 or higher)
  • npm (comes with Node.js)

Next, follow thoses procedures:

  1. Clone the repository:

    git clone https://github.com/Socrimoft/classic2.git
    cd classic2
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run start
  4. Open your browser and navigate to: http://localhost:8080

Acknowledgments

Note: While making the game, some contents that are not under an open source license were used as placeholder. It is possible that some of them still remains: feel free to report such content to us to remove them.


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published