redme

README.md

@@ -0,0 +1,82 @@
+Thank you for using DVN!
+
+DVN is a Godot Visual novel example project.
+
+If you need help using features of DVN, click "Search Help" on the Top Left of
+the middle editor window (to the left of "Inspector")
+
+DVN is made up of 3 new classes:
+	
+- DVNScene: The class that contains all the functions that DVN uses, every scene
+should inherit from this class, as well as dvn.tscn. If you want to make a new scene,
+press ctrl+shift+N (or click scene>new inherited scene) and choose to inherit from dvn.tscn.
+you can edit your inherited scene to your heart's content, but editing dvn.tscn itself, or dvn.gd will
+change the way DVN itself works. If you want to add to DVNScene's functions, feel free to. You can also just
+call super() and then run your custom code.
+
+etc. 
+
+# In your scene vvv
+func create_text_balloon():
+	super()
+	#YOUR ADDITIONAL CODE HERE
+
+-DVNLabel: An extension of Godot Dialogue Manager's DialogueLabel compatible
+with talktones and autotext. 
+
+Within your Balloon scene you can set exports for talktones, voice clips, autotext etc.
+
+You shouldn't be needing to call anything from here, 
+but if you have trouble with the way your dialogue is being drawn, feel free to check
+how it works. 
+
+-DVNBalloon: A copy of Godot Dialogue Manager's default balloon, configured to work
+with DVNLabels as well as DialogueLabels. There's a region in the script for label references,
+feel free to add them there (you can also add them to your scene's script, or a global script).
+You can also edit dvn_balloon.gd yourself, it's highly recommended you make a copy and edit it if 
+you want your baloon running custom code.
+
+DVN is simply an add on to an addon. You can make new classes and shit if you want.
+Keep and mind i will be updating DVN through git if needed, so i recommend you dont edit anything within
+the DVN folder, unless you're willing to resolve conflicts.
+
+
+Dialogue is handled by Nathan Hoad's "Godot Dialogue Manager" extension
+for help with anything related to the Godot Dialogue Manager, consult its GitHub page
+https://github.com/nathanhoad/godot_dialogue_manager
+
+For help with anything Godot related, check the documentation. 
+Either by clicking "Search Help" in the top right of the script editor,
+By right clicking a node type, or by going to
+https://docs.godotengine.org/en/stable/
+
+DVN is made for Godot 4.3, keep in mind there are major differences between 
+Godot 4 and Godot 3. Mostly function names.
+
+DVN is CC0 open source <------ lame way of saying, use my code i dont care what you do with it, and you dont need to credit me
+
+my name is TY TIRAMISU, if you do want to credit me :>
+
+as for the Godot Dialogue Manager?
+
+MIT License
+
+Copyright (c) 2022-present Nathan Hoad and Dialogue Manager contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.