This is a plugin for NeosVR that lets you import EPUB e-books into a specific format that can be used to display them in the metaverse.
It uses the EpubSharp library to import EPUBs, some books may not work.
The following is just some general advice on copyright. Don't take it word for word as the developers are no legal experts. Please consult the laws applicable to you if you are unsure.
If you import ebooks into NeosVR and sync them to the cloud, you are only allowed to share them with other people if you actually have the right to do so. If the book is in the public domain, you can probably share it in public folders or hand them to other people, but don't take me up on that. On the other hand, if the book is under copyright or other licsenses that prohibit distribution of said book, you are only allowed to use it for yourself and NOT share it with others.
No legal liability falls upon the developers of this tool, you are responsible for your own doings. The tools just provides the means to import ebooks, what you do with the ebooks is your responsibility.
- Download the necessary files from the reselse section to the right
- Put all the .dll files into your NeosVR installions Libraries folder
- Open the NeosVR Launcher and select the NeosEBookImporter.dll in the "Load Extra Libraries" section
- Start NeosVR
- Using a DevTooltip create a new empty objects
- Attach the ebook importer plugin in the "EBook Importer" section of the component selection
- Enter a valid local path to an epub file or a directory containing epub files
- If you recusively want to import all epubs of a folder hierarchy check the Recursive checkbox (this can take a while depending on the number of ebooks)
- Check out the code or download it as a zip from Github
- Make sure you have Visual Studio 2019 and the .Net Framework 4.6.2 installed
- Open the NeosEBookImporter.sln file in Visual Studio
- Rebind the NeosVR dlls if you they are not found immediatelly. Check the NeosVR Wiki for more information.
- Click Build -> Build Solution
- If you installed NeosVR on Steam to your C: drive the dlls are automatically copied there, so you just need to start the NeosVR Launcher
- If you installed it somewhere else, copy all the dlls from the bin folder of the project to your NeosVR Libraries folder
The plugin creates an EBook in NeosVR in a certain format. Data is stored in Dynamic Variables for easy access. The DynVars all bind to the same DynVar space, but no Dynamic Variable Space is attached to the book. If you attach a DynVarSpace to you ebook reader and parent the book under it you have easy access to the variables.
DynVar Space: EBook
Variable name | Type | Description |
---|---|---|
EBook/Title | String | The ebook title |
EBook/AuthorCount | int | The number of authors that wrote the book |
EBook/Author# | String | A specific author. # is the 0 based index of the author. So the first author is Author0, the second one Author1, and so on. |
EBook/ChapterCount | int | The number of chapters in the book |
EBook/Chapter# | String | The contents of a specific chapter. # is also the 0 based index like the authors. |
EBook/ChapterTitle# | String | The title of the specific chapter. # is the index again |
EBook/CurrentChapter | int | The current chapter. Used as a bookmark. |
EBook/CurrentPosition | int | The current position in the current chapter. The actual char index of the chapter string. Also used as a bookmark. Starts at -1 for title page. |