NeosVR-Headless-API

This is the wiki for NeosVR-Headless-API. It is a Python wrapper and API for the NeosVR headless client which enables programmatic control of the headless client both locally and remotely.

At the moment, this library will only work on Linux systems. Please make sure your Mono version is up to date and that you're able to launch the headless client by itself first before attempting to use this library.

If you're ready to jump right in, check out the Getting started page.

If you run a headless client in a Docker container, check out our Docker container page.

Also, check out Issues and known bugs for stuff to be aware of.

Finally, the online documentation explains all the methods available and their syntax.

FAQ

What is a "wrapper?"

NeosVR-Headless-API starts the headless client itself and hooks into the console to "type" commands, then it captures the output of those commands. In other words, it "wraps" around the headless client console and assumes total control of it. This means this library can be used on a completely vanilla headless client - no plugins required.

What projects or events have used this?

This library was the backbone of hosting Virtual BLFC, a virtual event held by Biggest Little Fur Con which was the first event in Neos of its scale. The event consisted of multiple headless clients on multiple servers, all using NeosVR-Headless-API. It is proven to work well over extended periods of time.

Where do I get the headless client?

Please refer to the Neos Wiki for the requirements needed to get early access to headless client builds.

Isn't Neos a crypto grift?

Currently, statements made on the official Neos Twitter or website do not reflect the views or values of the rest of the Neos development team as per a statement by their lead developer, Frooxius. The cause of this boils down to an internal conflict and hostile takeover by Neos' crypto-shilling CEO. There are many sources indicating that the Neos team as a whole as well as its talented content creators and users condemn Neos' PR push of a crypto and NFT stained metaverse:

• https://twitter.com/GeenzVR/status/1492197429973643266 (Neos staff)
• https://twitter.com/Veer_NeosVR/status/1492163466282647553 (Neos staff)
• https://twitter.com/AbrahamTheDrago/status/1492162508404101121
• https://twitter.com/ChromaShiba/status/1492162171203059712
• https://twitter.com/dovahdovolom/status/1492174386354393092
• https://twitter.com/Electronus97/status/1492163246928936970
• https://twitter.com/lacydoes/status/1492296370144878592
• https://twitter.com/LargeBat/status/1491889704807149571
• https://twitter.com/philpax_/status/1492217049459867648
• https://twitter.com/RileyGuy1000/status/1492162445410021387
• https://twitter.com/scitiv/status/1492241638156025857
• https://twitter.com/SpazmanNSFW/status/1492171465357242371
• https://twitter.com/SpexButContent/status/1491914892013551616
• https://twitter.com/VixusFoxy/status/1492434951186235394

NeosVR-Headless-API was initially written for hosting virtual events within the furry fandom, which makes up a significant portion of Neos' user base and creates much of its unique avatars and content. This project was open sourced in the hopes that it will be used to host other events in a similar vein. As such, obnoxious crypto grifters will get very little or nonexistent support for this project outside of the documentation provided.