|
1 | | -# Godot XR Template |
| 1 | +# Pineapple Pier |
2 | 2 |
|
3 | | - |
4 | | - |
5 | | - |
6 | | - |
| 3 | +Pineapple Pier is our VR game for the 2024-2025 season. |
7 | 4 |
|
8 | | -This repository contains a template Godot project for building a simple VR game. |
| 5 | +## Prompt |
9 | 6 |
|
| 7 | +> Participants use video and 3D computer graphics tools and design processes to create a two-to-three-minute VR visualization (accompanied by supporting documentation) that addresses the annual theme. |
| 8 | +> Semifinalists deliver a presentation about their visualization and participate in an interview. |
10 | 9 |
|
11 | | -## Versions |
| 10 | +## Theme |
12 | 11 |
|
13 | | -Official releases are tagged and can be found [here](https://github.com/GodotVR/godot-xr-template/releases). |
| 12 | +The challenge for the 2024-2025 season is as follows: |
14 | 13 |
|
15 | | -The following branches are in active development: |
16 | | -| Branch | Description | Godot version | |
17 | | -|----------|-------------------------------|-----------------| |
18 | | -| main | Current development branch | Godot 4.2+ | |
19 | | -| 4.1 | Godot 4.1 development branch | Godot 4.1 | |
20 | | -| 3.x | Godot 3.x development branch | Godot 3.5+ | |
| 14 | +> Create a virtual reality (VR) simulation of a family vacation destination that includes experiences and activities that appeal to both young children and teenagers. |
21 | 15 |
|
| 16 | +## Licensing |
22 | 17 |
|
23 | | -# Assets |
24 | | - |
25 | | -This project uses the following assets: |
26 | | - - [Godot XR Tools](https://godotengine.org/asset-library/asset/1515) |
27 | | - - [OpenXR Vendors](https://github.com/GodotVR/godot_openxr_vendors) |
28 | | - |
29 | | - |
30 | | -# Getting Started |
31 | | - |
32 | | -Start by downloading this asset from github; or by installing it from the Godot |
33 | | -Asset Library. |
34 | | - |
35 | | -The game should be playable with a splash screen and two example scenes the player |
36 | | -can move between. |
37 | | - |
38 | | -The game should be customized by: |
39 | | - - Modifying the splash-screen texture to represent the game |
40 | | - - Modifying the icon.png for the game |
41 | | - - Add game state variables to the game_state.gd singleton class |
42 | | - - Replacing the demo zones with zones suitable to the game |
43 | | - |
44 | | - |
45 | | -# Exporting to Android |
46 | | - |
47 | | -The template contains a copy of the XR loaders plugin |
48 | | -and preconfigured exports for android based headsets that support OpenXR. |
49 | | - |
50 | | -Before this can be used you do need to install the android build template. |
51 | | -Select the menu `Editor->Manage Export Templates...` to download the templates. |
52 | | -Select the menu `Project->Install Android Build Template...` to install the template. |
53 | | - |
54 | | -Make sure you set the correct entry in the export templates to runable |
55 | | -if you want to use one click deploy to your device. |
56 | | - |
57 | | -Please refer to the official documentation for Godots prerequisits for exporting to android: |
58 | | -https://docs.godotengine.org/en/stable/tutorials/export/exporting_for_android.html |
59 | | - |
60 | | -# Recommended Asset Locations |
61 | | - |
62 | | -Common areas to find assets are: |
63 | | - - [Godot Asset Library](https://godotengine.org/asset-library/asset) |
64 | | - - [AmbientCG](https://ambientcg.com/) for object and sky textures |
65 | | - - [FreePD.com](https://freepd.com/) for sound tracks |
66 | | - - [FreeSound](https://freesound.org/) for sound effects |
67 | | - - [Kenney.nl](https://kenney.nl/) |
68 | | - |
69 | | - |
70 | | -# More Information |
71 | | - |
72 | | -Information on the Godot XR Tools can be found on [the website](https://godotvr.github.io/godot-xr-tools/). |
73 | | - |
| 18 | +This project was bootstrapped with [godot-xr-template](https://github.com/GodotVR/godot-xr-template), which is licensed under the [MIT License](https://github.com/GodotVR/godot-xr-template?tab=MIT-1-ov-file#readme) |
0 commit comments