dfpyre 0.4.5__tar.gz → 0.5.0__tar.gz

{dfpyre-0.4.5 → dfpyre-0.5.0}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Amp
-
-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.
+MIT License
+
+Copyright (c) 2023 Amp
+
+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.

{dfpyre-0.4.5 → dfpyre-0.5.0}/PKG-INFO

@@ -1,16 +1,18 @@
 Metadata-Version: 2.1
 Name: dfpyre
-Version: 0.4.5
+Version: 0.5.0
 Summary: A package for external creation of code templates for the DiamondFire Minecraft server.
 Home-page: https://github.com/Amp63/pyre
 License: MIT
-Keywords: diamondfire,minecraft
+Keywords: diamondfire,minecraft,template,item
 Author: Amp
-Requires-Python: >=3.12,<4.0
+Requires-Python: >=3.10,<4.0
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: mcitemlib (>=0.1.0,<0.2.0)
+Requires-Dist: mcitemlib (>=0.1.2,<0.2.0)
 Project-URL: Repository, https://github.com/Amp63/pyre
 Description-Content-Type: text/markdown
 
@@ -20,10 +22,17 @@ A package for external creation of code templates for the DiamondFire Minecraft
 
 PyPi Link: https://pypi.org/project/dfpyre/
 
+## Installation
+
+Run the following command in a terminal:
+```
+pip install dfpyre
+```
+
 ## Features
 - All code block types
 - All code item types
-- Direct sending to DF via recode
+- Direct sending to DF via recode or codeclient
 - Automatic type conversion (int to num, str to text)
 - Name checking ("did you mean ___?" for close matches)
 - Default tag values
@@ -32,7 +41,7 @@ PyPi Link: https://pypi.org/project/dfpyre/
 ## Basics
 
 - [Setting up a program](#setup)
-- [Events and Actions](#eventsactions)
+- [Events and Actions](#events-and-actions)
 - [Building](#building)
 
 ## Var Items
@@ -47,16 +56,17 @@ PyPi Link: https://pypi.org/project/dfpyre/
 - [Potion](#potion)
 - [Game Value](#game-value)
 - [Vector](#vector)
+- [Parameter](#parameter)
 
 ## Conditionals and Loops
 
-- [Conditionals and Brackets](#conditionalsbrackets)
+- [Conditionals and Brackets](#conditionals-and-brackets)
 - [Loops](#loops)
 
 ## Functions and Procedures
 
-- [Creating Functions and Procedures](#create-functionsprocedures)
-- [Calling Functions and Procedures](#call-functionsprocedures)
+- [Creating Functions and Processes](#creating-functions-and-processes)
+- [Calling Functions and Processes](#calling-functions-and-processes)
 
 ## Extras
 
@@ -92,14 +102,14 @@ Here's a complete program that prints a message to every player when a player jo
 ```py
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
-t.buildAndSend()
+t.player_event('Join')
+t.player_action('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
+t.build_and_send('codeclient')
 ```
 
-### Events/Actions
+### Events and Actions
 
-You can find a list of events and actions [here](#commands)
+You can find a list of events and actions [here](#method-list)
 
 As shown in [setup](#setup), every code line must start with an event, function, or process. After that, you're free to put anything you want.
 
@@ -108,14 +118,14 @@ The following program sends a message to all players and gives a player 10 apple
 ```py
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
-t.playerAction('GiveItems', item('apple', 10))
+t.player_event('Join')
+t.player_action('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
+t.player_action('GiveItems', item('apple', 10))
 ```
 
 ### Building
 
-You basically have 2 different options for building your code line.
+You have 2 different options for building your code line.
 You can either:
 
 1. Save the compressed template code to a variable and send it to minecraft later
@@ -126,11 +136,9 @@ If you choose the first option, the code would look something like this:
 ```py
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
-templateCode = t.build()
-
-sendToDf(code, name='myJoinTemplate')  # Send to minecraft client via recode item api
+t.player_event('Join')
+t.player_action('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
+template_code = t.build()  # do whatever you want with this
 ```
 
 If you choose the second option, you can do this:
@@ -138,9 +146,9 @@ If you choose the second option, you can do this:
 ```py
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
-t.buildAndSend()  # builds and sends automatically to minecraft
+t.player_event('Join')
+t.player_action('SendMessage', '%default has joined!', target=Target.ALL_PLAYERS)
+t.build_and_send('codeclient')  # builds and sends automatically to minecraft
 ```
 
 ### Variable Items
@@ -157,8 +165,8 @@ If a regular string is passed to a method as a chest parameter, it will automati
 
 ```py
 # These do the same thing:
-t.playerAction('SendMessage', text('%default joined.'))
-t.playerAction('SendMessage', '%default joined.')
+t.player_action('SendMessage', text('%default joined.'))
+t.player_action('SendMessage', '%default joined.')
 ```
 
 ### Number
@@ -174,8 +182,8 @@ If a regular integer or float is passed to a method as a chest parameter, it wil
 
 ```py
 # These do the same thing:
-t.setVariable('=', var('number'), num(10))
-t.setVariable('=', var('number'), 10)
+t.set_variable('=', var('number'), num(10))
+t.set_variable('=', var('number'), 10)
 ```
 
 ### Variable
@@ -187,27 +195,43 @@ var('num')
 var('text1')
 ```
 
-You can set variable values by using the `setVariable` method:
+You can set variable values by using the `set_variable` method:
+
+```py
+t.set_variable('=', var('num'), 12)  # sets 'num' to 12
+t.set_variable('x', var('doubled'), var('num'), 2)  # sets 'doubled' to 24
+```
+
+You can set the scope of the variable by using the `scope` argument:
 
 ```py
-t.setVariable('=', var('num'), 12)  # sets 'num' to 12
-t.setVariable('x', var('doubled'), var('num'), 2)  # sets 'doubled' to 24
+t.set_variable('=', var(num1, scope='unsaved'), 12)  # `unsaved` is the same as a game variable.
+t.set_variable('=', var(num1, scope='saved'), 12)
+t.set_variable('=', var(num1, scope='local'), 12)
 ```
 
-You can set the scope of the variable by using the `scope` keyword:
+#### Shorthand Variables
 
+You can also use the variable shorthand format like this:
 ```py
-t.setVariable('=', var(num1, scope='game'), 12)  # both 'game' or 'unsaved' can be passed for the scope here
-t.setVariable('=', var(num1, scope='saved'), 12)
-t.setVariable('=', var(num1, scope='local'), 12)
+# These do the same thing:
+t.set_variable('=', var('lineVar', scope='line'), 5)
+t.set_variable('=', '$ilineVar', 5)
 ```
 
+Shorthand vars should be formatted like this: `$[scope id][var name]`
+
+Here's a list of the scope IDs:
+- `g` = Game (unsaved)
+- `s` = Saved
+- `l` = Local
+- `i` = Line
+
 ### Location
 
 Represents a diamondfire location item:
 
 ```py
-# (var= is not required if numbers are in order, but is more readable)
 loc(x=25.5, y=50, z=25.5, pitch=0, yaw=-90)
 ```
 
@@ -217,8 +241,8 @@ Example:
 # teleport player on join
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('Teleport', loc(10, 50, 10))
+t.player_event('Join')
+t.player_action('Teleport', loc(10, 50, 10))
 ```
 
 ### Item
@@ -230,7 +254,7 @@ item('stick', count=5)
 item('stone', 64)
 ```
 
-Extra nbt (enchants, lore, etc.) is not supported right now.
+To add extra data to an item, you can use any methods from the [mcitemlib](https://github.com/Amp63/mcitemlib) library
 
 ### Sound
 
@@ -246,8 +270,8 @@ Example:
 # plays 'Grass Place' sound on join
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('PlaySound', sound('Grass Place'))
+t.player_event('Join')
+t.player_action('PlaySound', sound('Grass Place'))
 ```
 
 ### Particle
@@ -264,8 +288,8 @@ Example:
 # plays a white cloud particle effect at 5, 50, 5
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('Particle', particle('Cloud'), loc(5, 50, 5))
+t.player_event('Join')
+t.player_action('Particle', particle('Cloud'), loc(5, 50, 5))
 ```
 
 Currently, the particle object does not support colors.
@@ -285,8 +309,8 @@ Example:
 # gives the player infinite saturation 255
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('GivePotion', potion('Saturation', amp=254))
+t.player_event('Join')
+t.player_action('GivePotion', potion('Saturation', amp=254))
 ```
 
 ### Game Value
@@ -305,7 +329,7 @@ Example:
 from dfpyre import *
 t = DFTemplate()
 t.function('printData')
-t.playerAction('SendMessage', gamevalue('Player Count'), gamevalue('CPU Usage'))
+t.player_action('SendMessage', gamevalue('Player Count'), gamevalue('CPU Usage'))
 ```
 
 ### Vector
@@ -322,8 +346,8 @@ Example:
 # sets the player's x velocity to 1.0 on join
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.playerAction('SetVelocity', vector(x=1.0, y=0.0, z=0.0))
+t.player_event('Join')
+t.player_action('SetVelocity', vector(x=1.0, y=0.0, z=0.0))
 ```
 
 ### Parameter
@@ -340,12 +364,12 @@ Example:
 # builds a function that says "Hello, [name]" where `name` is the inputted parameter.
 from dfpyre import *
 t = DFTemplate()
-nameParameter = parameter('name', ParameterType.TEXT)
-t.function('SayHi', nameParameter)
-t.playerAction('SendMessage', 'Hello, ', var('name', 'line'))
+name_parameter = parameter('name', ParameterType.TEXT)
+t.function('SayHi', name_parameter)
+t.player_action('SendMessage', 'Hello, ', var('name', 'line'))
 ```
 
-### Conditionals/Brackets
+### Conditionals and Brackets
 
 A list of conditionals and loops can be found [here](#commands).
 
@@ -355,10 +379,10 @@ A specific syntax must be followed when creating conditionals and loops. Each co
 # prints 'clicked' when a player right clicks with a stick in their hand
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('RightClick')
-t.ifPlayer('IsHolding', item('stick'))
+t.player_event('RightClick')
+t.if_player('IsHolding', item('stick'))
 t.bracket(
-    t.playerAction('SendMessage', 'clicked')
+    t.player_action('SendMessage', 'clicked')
 )
 ```
 
@@ -369,13 +393,13 @@ To create an `else` statement, use the `else_` method:
 from dfpyre import *
 t = DFTemplate()
 t.function('grounded')
-t.ifPlayer('IsGrounded')
+t.if_player('IsGrounded')
 t.bracket(
-    t.playerAction('ActionBar', 'on the ground')
+    t.player_action('ActionBar', 'on the ground')
 )
 t.else_()
 t.bracket(
-    t.playerAction('ActionBar', 'in the air')
+    t.player_action('ActionBar', 'in the air')
 )
 t.build()
 ```
@@ -388,14 +412,14 @@ As for loops, the bracket syntax is the same and will automatically change to "r
 # prints numbers 1-5
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
+t.player_event('Join')
 t.repeat('Multiple', var('i'), 5)
 t.bracket(
-    t.playerAction('SendMessage', var('i'))
+    t.player_action('SendMessage', var('i'))
 )
 ```
 
-### Creating Functions/Processes
+### Creating Functions and Processes
 
 To create a function or process, just start the template with a `function` or `process` method:
 
@@ -404,45 +428,45 @@ To create a function or process, just start the template with a `function` or `p
 from dfpyre import *
 t = DFTemplate()
 t.function('doStuff')
-t.playerAction('GiveItems', item('golden_apple', 64))
+t.player_action('GiveItems', item('golden_apple', 64))
 ```
 
-### Calling Functions/Processes
+### Calling Functions and Processes
 
 Calling Functions and processes is also simple:
 
 ```py
 from dfpyre import *
 t = DFTemplate()
-t.playerEvent('Join')
-t.callFunction('doStuff')
+t.player_event('Join')
+t.call_function('doStuff')
 ```
 
 ### Method List
 
 - Events / Function / Process
-  - playerEvent
-  - entityEvent
+  - player_event
+  - entity_event
   - function
   - process
-  - callFunction
-  - startProcess
+  - call_function
+  - start_process
 
 - Actions
-  - playerAction
-  - gameAction
-  - entityAction
+  - player_action
+  - game_action
+  - entity_action
 
 - Conditionals / Loops
-  - ifPlayer
-  - ifVariable
-  - ifGame
-  - ifEntity
-  - else_ (don't forget underscore)
+  - if_player
+  - if_variable
+  - if_game
+  - if_entity
+  - else_
   - repeat
   - bracket
 
 - Other
   - control
-  - selectObject
-  - setVariable
+  - select_object
+  - set_variable