PyPI - pywargame - Versions diffs - 0.3.1__py3-none-any.whl - Mend

pywargame 0.3.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (150) hide show

pywargame/__init__.py +2 -0
pywargame/common/__init__.py +3 -0
pywargame/common/collector.py +87 -0
pywargame/common/dicedraw.py +363 -0
pywargame/common/drawdice.py +40 -0
pywargame/common/singleton.py +22 -0
pywargame/common/test.py +25 -0
pywargame/common/verbose.py +59 -0
pywargame/common/verboseguard.py +53 -0
pywargame/cyberboard/__init__.py +18 -0
pywargame/cyberboard/archive.py +283 -0
pywargame/cyberboard/base.py +63 -0
pywargame/cyberboard/board.py +462 -0
pywargame/cyberboard/cell.py +200 -0
pywargame/cyberboard/collect.py +49 -0
pywargame/cyberboard/collectgbx0pwd.py +30 -0
pywargame/cyberboard/collectgbxext.py +30 -0
pywargame/cyberboard/collectgsnexp.py +32 -0
pywargame/cyberboard/collectgsnext.py +30 -0
pywargame/cyberboard/draw.py +396 -0
pywargame/cyberboard/exporter.py +1132 -0
pywargame/cyberboard/extractor.py +240 -0
pywargame/cyberboard/features.py +17 -0
pywargame/cyberboard/gamebox.py +81 -0
pywargame/cyberboard/gbxexp.py +76 -0
pywargame/cyberboard/gbxext.py +64 -0
pywargame/cyberboard/gsnexp.py +147 -0
pywargame/cyberboard/gsnext.py +59 -0
pywargame/cyberboard/head.py +111 -0
pywargame/cyberboard/image.py +76 -0
pywargame/cyberboard/main.py +47 -0
pywargame/cyberboard/mark.py +102 -0
pywargame/cyberboard/palette.py +36 -0
pywargame/cyberboard/piece.py +169 -0
pywargame/cyberboard/player.py +36 -0
pywargame/cyberboard/scenario.py +115 -0
pywargame/cyberboard/testgrid.py +156 -0
pywargame/cyberboard/tile.py +121 -0
pywargame/cyberboard/tray.py +68 -0
pywargame/cyberboard/windows.py +41 -0
pywargame/cyberboard/zeropwd.py +45 -0
pywargame/cyberboard.py +2728 -0
pywargame/gbx0pwd.py +2776 -0
pywargame/gbxextract.py +2795 -0
pywargame/gsnexport.py +16499 -0
pywargame/gsnextract.py +2790 -0
pywargame/latex/__init__.py +2 -0
pywargame/latex/collect.py +34 -0
pywargame/latex/latexexporter.py +4010 -0
pywargame/latex/main.py +184 -0
pywargame/vassal/__init__.py +66 -0
pywargame/vassal/base.py +139 -0
pywargame/vassal/board.py +243 -0
pywargame/vassal/buildfile.py +60 -0
pywargame/vassal/chart.py +79 -0
pywargame/vassal/chessclock.py +197 -0
pywargame/vassal/collect.py +98 -0
pywargame/vassal/collectpatch.py +28 -0
pywargame/vassal/command.py +21 -0
pywargame/vassal/documentation.py +322 -0
pywargame/vassal/dumpcollect.py +28 -0
pywargame/vassal/dumpvsav.py +28 -0
pywargame/vassal/element.py +439 -0
pywargame/vassal/exporter.py +89 -0
pywargame/vassal/extension.py +101 -0
pywargame/vassal/folder.py +103 -0
pywargame/vassal/game.py +940 -0
pywargame/vassal/gameelements.py +1091 -0
pywargame/vassal/globalkey.py +127 -0
pywargame/vassal/globalproperty.py +433 -0
pywargame/vassal/grid.py +573 -0
pywargame/vassal/map.py +1061 -0
pywargame/vassal/mapelements.py +1020 -0
pywargame/vassal/merge.py +57 -0
pywargame/vassal/merger.py +460 -0
pywargame/vassal/moduledata.py +275 -0
pywargame/vassal/mrgcollect.py +31 -0
pywargame/vassal/patch.py +44 -0
pywargame/vassal/patchcollect.py +28 -0
pywargame/vassal/player.py +83 -0
pywargame/vassal/save.py +495 -0
pywargame/vassal/skel.py +380 -0
pywargame/vassal/trait.py +224 -0
pywargame/vassal/traits/__init__.py +36 -0
pywargame/vassal/traits/area.py +50 -0
pywargame/vassal/traits/basic.py +35 -0
pywargame/vassal/traits/calculatedproperty.py +22 -0
pywargame/vassal/traits/cargo.py +29 -0
pywargame/vassal/traits/click.py +41 -0
pywargame/vassal/traits/clone.py +28 -0
pywargame/vassal/traits/delete.py +24 -0
pywargame/vassal/traits/deselect.py +32 -0
pywargame/vassal/traits/dynamicproperty.py +112 -0
pywargame/vassal/traits/globalcommand.py +55 -0
pywargame/vassal/traits/globalhotkey.py +26 -0
pywargame/vassal/traits/globalproperty.py +54 -0
pywargame/vassal/traits/hide.py +67 -0
pywargame/vassal/traits/label.py +76 -0
pywargame/vassal/traits/layer.py +105 -0
pywargame/vassal/traits/mark.py +20 -0
pywargame/vassal/traits/mask.py +85 -0
pywargame/vassal/traits/mat.py +26 -0
pywargame/vassal/traits/moved.py +35 -0
pywargame/vassal/traits/movefixed.py +51 -0
pywargame/vassal/traits/nonrect.py +95 -0
pywargame/vassal/traits/nostack.py +55 -0
pywargame/vassal/traits/place.py +104 -0
pywargame/vassal/traits/prototype.py +20 -0
pywargame/vassal/traits/report.py +34 -0
pywargame/vassal/traits/restrictaccess.py +28 -0
pywargame/vassal/traits/restrictcommand.py +32 -0
pywargame/vassal/traits/return.py +40 -0
pywargame/vassal/traits/rotate.py +62 -0
pywargame/vassal/traits/sendto.py +59 -0
pywargame/vassal/traits/sheet.py +129 -0
pywargame/vassal/traits/skel.py +9 -0
pywargame/vassal/traits/stack.py +28 -0
pywargame/vassal/traits/submenu.py +27 -0
pywargame/vassal/traits/trail.py +61 -0
pywargame/vassal/traits/trigger.py +72 -0
pywargame/vassal/turn.py +272 -0
pywargame/vassal/upgrade.py +191 -0
pywargame/vassal/vmod.py +323 -0
pywargame/vassal/vsav.py +100 -0
pywargame/vassal/widget.py +358 -0
pywargame/vassal/withtraits.py +634 -0
pywargame/vassal/xml.py +4 -0
pywargame/vassal/zone.py +399 -0
pywargame/vassal.py +12500 -0
pywargame/vmodpatch.py +12548 -0
pywargame/vsavdump.py +12533 -0
pywargame/vslmerge.py +13015 -0
pywargame/wgexport.py +16689 -0
pywargame/ztexport.py +14351 -0
pywargame/zuntzu/__init__.py +5 -0
pywargame/zuntzu/base.py +82 -0
pywargame/zuntzu/collect.py +38 -0
pywargame/zuntzu/countersheet.py +250 -0
pywargame/zuntzu/dicehand.py +48 -0
pywargame/zuntzu/exporter.py +936 -0
pywargame/zuntzu/gamebox.py +154 -0
pywargame/zuntzu/map.py +36 -0
pywargame/zuntzu/piece.py +37 -0
pywargame/zuntzu/scenario.py +208 -0
pywargame/zuntzu/ztexp.py +115 -0
pywargame-0.3.1.dist-info/METADATA +353 -0
pywargame-0.3.1.dist-info/RECORD +150 -0
pywargame-0.3.1.dist-info/WHEEL +5 -0
pywargame-0.3.1.dist-info/licenses/LICENSE +5 -0
pywargame-0.3.1.dist-info/top_level.txt +1 -0

pywargame/vassal/documentation.py ADDED Viewed

@@ -0,0 +1,322 @@
+## BEGIN_IMPORT
+from common import VerboseGuard
+from . base import *
+from . element import Element
+from . gameelements import GameElement
+## END_IMPORT
+# ====================================================================
+def createKeyHelp(*args,**kwargs):
+    '''Creates a help file with key-bindings
+    See Documentation.createKeyHelp
+    '''
+    return Documentation.createKeyHelp(*args,**kwargs)
+# --------------------------------------------------------------------
+class Documentation(GameElement):
+    TAG=Element.MODULE+'Documentation'
+    def __init__(self,doc,node=None,**kwargs):
+        '''Documentation (or help menu)
+        Parameters
+        ----------
+        doc : Element
+            Parent
+        node : xml.dom.Element
+            Node to read state from
+        kwargs : dict
+            Attributes
+        '''
+        super(Documentation,self).__init__(doc,self.TAG,node=node,**kwargs)
+    def addAboutScreen(self,**kwargs):
+        '''Add a `AboutScreen` element to this
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        Returns
+        -------
+        element : AboutScreen
+            The added element
+        '''
+        return self.add(AboutScreen,**kwargs)
+    def addHelpFile(self,**kwargs):
+        '''Add a `HelpFile` element to this
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        Returns
+        -------
+        element : HelpFile
+            The added element
+        '''
+        return self.add(HelpFile,**kwargs)
+    def addBrowserHelpFile(self,**kwargs):
+        '''Add a `BrowserHelpFile` element to this
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        Returns
+        -------
+        element : BrowserHelpFile
+            The added element
+        '''
+        return self.add(BrowserHelpFile,**kwargs)
+    def addBrowserPDFFile(self,**kwargs):
+        '''Add a `BrowserPDFFile` element to this
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        Returns
+        -------
+        element : BrowserPDFFile
+            The added element
+        '''
+        return self.add(BrowserPDFFile,**kwargs)
+    def addTutorial(self,**kwargs):
+        '''Add a `Tutorial` element to this
+        Parameters
+        ----------
+        kwargs : dict
+            Dictionary of attribute key-value pairs
+        Returns
+        -------
+        element : Tutorial
+            The added element
+        '''
+        return self.add(Tutorial,**kwargs)
+    def getAboutScreens(self):
+        return self.getElementsByKey(AboutScreen,'title')
+    def getHelpFiles(self):
+        return self.getElementsByKey(HelpFile,'title')
+    def getBrowserHelpFiles(self):
+        return self.getElementsByKey(BrowserHelpFile,'title')
+    def getBrowserPDFFiles(self):
+        return self.getElementsByKey(BrowserPDFFile,'title')
+    def getTutorials(self):
+        return self.getElementsByKey(Tutorial,'name')
+    @classmethod
+    def createKeyHelp(cls,keys,title='',version=''):
+        '''Creates a help file with key-bindings
+        Parameters
+        ----------
+        keys : list of list of str
+             List of key-binding documentation
+        title : str
+             Title of help file
+        version : str
+             Version number
+        Returns
+        -------
+        txt : str
+            File content
+        '''
+        txt = f'''
+        <html>
+         <body>
+          <h1>{title} (Version {version}) Key bindings</h1>
+          <table>
+          <tr><th>Key</th><th>Where</th><th>Effect</th></tr>'''
+        for key, where, description in keys:
+            txt += (f'<tr><td>{key}</td>'
+                    f'<td>{where}</td>'
+                    f'<td>{description}</td></tr>')
+        txt += '''
+          </table>
+         </body>
+        </html>'''
+        return txt
+registerElement(Documentation)
+# --------------------------------------------------------------------
+class AboutScreen(Element):
+    TAG = Element.MODULE+'documentation.AboutScreen'
+    UNIQUE = ['title']
+    def __init__(self,doc,node=None,title='',fileName=""):
+        '''Create an about screen element that shows image
+        Parameters
+        ----------
+        doc : Element
+            Parent
+        node : xml.dom.Element
+            Node to read state from
+        title : str
+            Entry title
+        fileName : str
+            Internal file name
+        '''
+        super(AboutScreen,self).__init__(doc,
+                                         self.TAG,
+                                         node     = node,
+                                         fileName = fileName,
+                                         title    = title)
+    def getDocumentation(self):
+        '''Get Parent element'''
+        return self.getParent(Documentation)
+registerElement(AboutScreen)
+# --------------------------------------------------------------------
+class BrowserPDFFile(Element):
+    TAG = Element.MODULE+'documentation.BrowserPDFFile'
+    UNIQUE = ['title','pdfFile']
+    def __init__(self,doc,node=None,title='',pdfFile=''):
+        '''Create help menu item that opens an embedded PDF
+        Parameters
+        ----------
+        doc : Element
+            Parent
+        node : xml.dom.Element
+            Node to read state from
+        title : str
+            Entry title
+        pdfFile : str
+            Internal file name
+        '''
+        super(BrowserPDFFile,self).__init__(doc,self.TAG,
+                                            node    = node,
+                                            pdfFile = pdfFile,
+                                            title   = title)
+    def getDocumentation(self):
+        '''Get Parent element'''
+        return self.getParent(Documentation)
+registerElement(BrowserPDFFile)
+# --------------------------------------------------------------------
+class HelpFile(Element):
+    TAG = Element.MODULE+'documentation.HelpFile'
+    ARCHIVE = 'archive'
+    UNIQUE = ['title','fileName']
+    def __init__(self,doc,node=None,
+                 title='',
+                 fileName='',
+                 fileType=ARCHIVE):
+        '''Create a help menu entry that opens an embeddded file
+        Parameters
+        ----------
+        doc : Element
+            Parent
+        node : xml.dom.Element
+            Node to read state from
+        title : str
+            Entry title
+        fileName : str
+            Internal file name
+        fileType : str
+            How to find the file
+        '''
+        super(HelpFile,self).__init__(doc,self.TAG,node=node,
+                                      fileName = fileName,
+                                      fileType = fileType,
+                                      title    = title)
+    def getDocumentation(self):
+        '''Get Parent element'''
+        return self.getParent(Documentation)
+registerElement(HelpFile)
+# --------------------------------------------------------------------
+class BrowserHelpFile(Element):
+    TAG = Element.MODULE+'documentation.BrowserHelpFile'
+    UNIQUE = ['title','startingPage']
+    def __init__(self,doc,node=None,
+                 title='',
+                 startingPage='index.html'):
+        '''Create a help menu entry that opens an embeddded HTML
+        page (with possible sub-pages) file
+        Parameters
+        ----------
+        doc : Element
+            Parent
+        node : xml.dom.Element
+            Node to read state from
+        title : str
+            Entry title
+        startingPage : str
+            which file to start at
+        '''
+        super(BrowserHelpFile,self).__init__(doc,self.TAG,node=node,
+                                             startingPage=startingPage,
+                                             title=title)
+    def getDocumentation(self):
+        '''Get Parent element'''
+        return self.getParent(Documentation)
+registerElement(BrowserHelpFile)
+# --------------------------------------------------------------------
+class Tutorial(Element):
+    TAG = Element.MODULE+'documentation.Tutorial'
+    UNIQUE = ['name','logfile']
+    def __init__(self,doc,node=None,
+                 name            = 'Tutorial',
+                 logfile         = 'tutorial.vlog',
+                 promptMessage   = 'Load the tutorial?',
+                 welcomeMessage  = 'Press "Step forward" (PnDn) to step through the tutorial',
+                 launchOnStartup = True):
+        '''Add a help menu item that loads the tutorial
+        Also adds the start-up option to run the tutorial
+        Parameters
+        ----------
+        doc : Element
+            Parent
+        node : xml.dom.Element
+            Node to read state from
+        name : str
+            Name of entry
+        logfile : str
+            Internal file name
+        promptMessage : str
+            What to show
+        launchOnStartup : bool
+            By default, launch tutorial first time running module
+        '''
+        super(Tutorial,self).__init__(doc,self.TAG,node=node,
+                                      name            = name,
+                                      logfile         = logfile,
+                                      promptMessage   = promptMessage,
+                                      welcomeMessage  = welcomeMessage,
+                                      launchOnStartup = launchOnStartup)
+    def getDocumentation(self):
+        '''Get Parent element'''
+        return self.getParent(Documentation)
+registerElement(Tutorial)
+#
+# EOF
+#

pywargame/vassal/dumpcollect.py ADDED Viewed

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+import sys
+sys.path.append('..')
+from common import Verbose, VerboseGuard
+from common.collector import Collector
+if __name__ == '__main__':
+    from argparse import ArgumentParser, FileType
+    ap = ArgumentParser(description='Collect to single script')
+    ap.add_argument('output',
+                    type=FileType('w'),
+                    nargs='?',
+                    default='vsavdump.py',
+                    help='Output script name')
+    ap.add_argument('-v','--verbose',action='store_true',
+                    help='Be verbose')
+    args = ap.parse_args()
+    Verbose().setVerbose(args.verbose)
+    c = Collector()
+    c.run(args.output,
+          'vassal.py',
+          'dumpvsav.py')

pywargame/vassal/dumpvsav.py ADDED Viewed

@@ -0,0 +1,28 @@
+#!/usr/bin/env python
+## BEGIN_IMPORT
+from vassal import SaveIO
+## END_IMPORT
+if __name__ == '__main__':
+    from argparse import ArgumentParser
+    ap = ArgumentParser(description='Dump VASSAL save or log')
+    ap.add_argument('input',type=str,help='Input save')
+    ap.add_argument('-m','--meta',action='store_true',help='Also metadata')
+    args = ap.parse_args()
+    ret  = SaveIO.readSave(args.input,args.meta)
+    key, lines = ret[0], ret[1]
+    if args.meta:
+        savemeta, modulemeta = ret[2], ret[3]
+    print('\n'.join(lines))
+#
+#
+#