# Minetest Classroom

Minetest Classroom is a game for educators to teach anything with the voxel-based [Minetest game engine](https://minetest.net). Minetest Classroom allows you to create classrooms, which are unique 3D spaces that are bounded by walls and can contain anything. You can create many classrooms of any size and fill them with whatever content you want to teach with. When running Minetest Classroom on a multiplayer server, players can join and move between available classrooms, complete tasks, and receive rewards.

Classrooms can be a blank slate...


Classrooms can be randomly generated terrain...


Classrooms can have randomly generated biomes...


Classrooms can even be digital twins from real-world geographic data...

As a teacher, you can translate your lesson plans directly into tutorials by recording your player's actions, keystrokes, and movements in the game. Student players can then complete those tutorials and get rewarded items, tools, and privileges.

Minetest Classroom has a graphical user interface (GUI) that is accessible through the Student Notebook tool and the Teacher Controller tool. The Teacher Controller boasts a ton of features that allow you to easily create and manage classrooms, manage player interactions within classrooms, and (optionally) manage a multiplayer server.

## Quick install

### Windows

1. Install the latest version of the [Minetest game engine](https://minetest.net), then extract the folder to your computer. Create a shortcut on your desktop to the executable located in the "bin" folder by right-clicking the "minetest.exe" file and selecting "Send to" > "Desktop (create shortcut)".
2. Install Minetest Classroom by downloading the latest release of this repository and then extracting the content into the "games" folder of your Minetest directory from Step 1.
3. Run Minetest from the shortcut you created in Step 1 or by directly executing the executable. When you see the Minetest Game splash screen, click the Minetest Classroom game icon at the bottom to create a new Minetest Classroom game world.

## Creating your first classroom in under 5 minutes

1. Launch a Minetest Classroom game world. Refer to the Quick Install steps above.
2. Once you join the game, left-click while holding the Teacher Controller tool to access the teacher GUI.
3. Click the Classrooms tab at the top or the Classrooms image icon on the right.
4. Give your classroom a name and pick some dimensions (X and Z are the plane you walk on, Y is height).
5. Leave everything else as-is and click the Generate Classroom button at the bottom.
6. Ta-da! Your new classroom should now appear in the left-hand list. Select it then click the Teleport button.

Read more detailed documention and recipes for creating any kind of classroom on our [wiki page](https://github.com/ubc-minetest-classroom/minetest_classroom/wiki).

## Using the Teacher Controller tool

## Using the Student Notebook tool

## Using the tutorial recording tool

## Completing tutorials

## Contributing

## Asset Licenses
- `mc_teacher` modified from Ruben Wardy's `classroom` (LGPLv2.1+).
- `mc_mapper` modified from 4aiman's `mapp`
- Page turning sound (page_turn.ogg) is by [flag2](https://freesound.org/people/flag2/sounds/63318/) (CC BY 3.0).
- Woosh sound (teleport.ogg) is by [florianreichelt](https://www.instagram.com/florianreichelt/) (CC0 1.0)
- Bell timer sound (timer_bell.ogg) is by [maphill](https://freesound.org/people/maphill/sounds/204103/) (CC0 1.0)
- Report alert sound (report_alert.ogg) is by [Beetlemuse](https://freesound.org/people/Beetlemuse/sounds/529626/) (CC BY 4.0)
- Grass in the wind sound (grass-wind.ogg) is by [ciccarelli](https://freesound.org/people/ciccarelli/sounds/135870/) (CC0 1.0)
- Jungle sound (jungle.ogg) is by [aurelien.leveque](https://freesound.org/people/aurelien.leveque/sounds/417635/) (CC0 1.0)
- Forest birds sound (forest-birds.ogg) is by [taavhaap](https://freesound.org/people/taavhaap/sounds/528661/) (CC BY 4.0)
- Ocean and seagulls sound (ocean-seagulls.ogg) is by [juskiddink](https://freesound.org/people/juskiddink/sounds/149488/) (CC BY 4.0)
- Arctic wind sound (arctic-wing.ogg) is by [cobratronik](https://freesound.org/people/cobratronik/sounds/117136/) (CC0 1.0)
- Tide pools sound (tide-pools.ogg) is by pauldpickell (CC BY SA 4.0)
- Theme 1 sound is by [adamfk](https://freesound.org/people/adamfk/sounds/83647/) (CC0 1.0)
- Theme 2 sound is by [oymaldonado](https://freesound.org/people/oymaldonado/sounds/544019/) (CC BY 3.0)
- Theme 3 sound is by [emirdemirel](https://freesound.org/people/emirdemirel/sounds/424910/) (CC BY 4.0)
- Theme 4 sound is by [3bagbrew](https://freesound.org/people/3bagbrew/sounds/345028/) (CC0 1.0)
- Theme 5 sound is by [qubodup](https://freesound.org/people/qubodup/sounds/173923/) (CC0 1.0)
- Theme 6 sound is by [rtb45](https://freesound.org/people/RTB45/sounds/160489/) (CC BY 4.0)
- Theme 7 sound is by [glen-hoban](https://freesound.org/people/Glen_Hoban/sounds/439336/) (CC BY 4.0)
- Theme 8 sound is by [cctv123](https://freesound.org/people/cctv123/sounds/664894/) (CC BY 1.0)
- Theme 9 sound is by [ajubamusic](https://freesound.org/people/ajubamusic/sounds/320806/) (CC BY 3.0)
- Theme 10 sound is by [jamesfarrell_97](https://freesound.org/people/JamesFarrell_97/sounds/566504/) (CC BY 3.0)
- Theme 11 sound is by [tomlija](https://freesound.org/people/Tomlija/sounds/110333/) (CC BY 3.0)
- Map splashscreens (overlays 1-12) by pauldpickell (CC BY SA 4.0)
- `mc_rules` header by pauldpickell (CC BY 4.0)
