├── LICENSE
└── README.md


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 IgbarVonSquid
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Surf_Udon
 2 | A prefab for making surf maps in VRChat!
 3 | ### DISCLAIMER
 4 | This is not the same as the surf from Source games! Trying to port surf maps from Source will NOT WORK. While I hope to get it to be somewhat similar over time I don't think it will ever be the exact same. You also shouldn't be uploading other people's work without their permission regardless.
 5 | ## [Download latest version](https://github.com/IgbarVonSquid/Surf_Udon/releases)
 6 | ## Prefab includes:
 7 | - Surf controller
 8 | - HUD system
 9 | - Stream overlay
10 | - Velocity indicator
11 | - Timer
12 | - Stage controller
13 | - Input displayer
14 | - Settings menu
15 | - Voice range extender
16 | - Knives
17 | - Leaderboard
18 | - Teleporters
19 | - Ramps and boosters
20 | - Tutorial scene
21 | - [MerlinUI](https://github.com/MerlinVR/MUI)
22 | ## Requirements
23 | - Unity 2019.4.29f1
24 | - [VRChat SDK3](https://vrchat.com/home/download)
25 | ## Setup
26 | 1. Download the latest SDK3 – Worlds Unitypackage from VRChat (SDK2 will not work!)
27 | 2. Import the SDK into your Unity project.
28 | 3. Find the VRCWorld prefab under VRChat Examples > Prefabs and drag it into your scene.
29 | 4. Bring up the VRChat SDK Control Panel, login, then click the prompts to build the Layers and Collision Matrix.
30 | 5. Find the Surf_Systems prefab in the Surf_Udon folder and drag it into your scene.
31 | 6. At this point you should Build & Test the scene to make sure everything works. Simply jump from the starting platform to the finish platform while watching your velocity, time, etc to make sure all the systems work as expected.
32 | 7. You can now start building out a basic course. You’ll find ramps and boosters in their respective folders under the Surf_Udon > prefabs folder. If you ever get lost or confused you can refer to the Tutorial Scene in the Surf_Udon folder to see how things are setup there.
33 | 


--------------------------------------------------------------------------------