diff --git a/README.md b/README.md index f1f116d..cd79f5e 100644 --- a/README.md +++ b/README.md @@ -1 +1,78 @@ -# BOX v0.2 BOX is an Assetto Corsa framework created by Marco 'Marocco2' Mollace. It's created for Assetto Corsa developers who want a set of features without spending so much time. ## WARNING!!!! ### **This is an unstable SDK, so functions can be deprecated very soon. Check changelog or wiki what is changed** ### CURRENT FEATURES - A push notification system via Telegram bot - Sound player - An auto-update/auto-install system `(WORK IN PROGRESS)` ### PLANNED FEATURES - Voice commands ## IMPLEMENTATION Your app must have the following structure: ![Files](http://i.imgur.com/rofq8St.png) In your app python (in this example `BoxApp.py`) you need to add these lines: ... import sys import os import platform if platform.architecture()[0] == "64bit": sysdir = "stdlib64" else: sysdir = "stdlib" sys.path.insert(0, os.path.join(os.path.dirname(__file__), "box", sysdir)) os.environ['PATH'] = os.environ['PATH'] + ";." ... import traceback import ctypes import threading importError = False try: from box import box, sim_info, win32con except: ac.log('BoxApp: error loading modules: ' + traceback.format_exc()) importError = True ... ## CHANGELOG ### v0.2 - class SoundPlayer is now working ### v0.1.3 - first attempt to make newupdate() work ### v0.1.2 - reworked functions (check Wiki page) ### v0.1.1 - added getZipFile function \ No newline at end of file +# BOX v0.2 + +BOX is an Assetto Corsa framework created by Marco 'Marocco2' Mollace. It's created for Assetto Corsa developers who want a set of features without spending so much time. + +## WARNING!!!! + +### **This is an unstable SDK, so functions can be deprecated very soon. Check changelog or wiki what is changed** + +### CURRENT FEATURES + +- A push notification system via Telegram bot +- Sound player +- An auto-update/auto-install system `(WORK IN PROGRESS)` + +### PLANNED FEATURES + +- Voice commands + +## IMPLEMENTATION + +Your app must have the following structure: + +![Files](http://i.imgur.com/rofq8St.png) + +In your app python (in this example `BoxApp.py`) you need to add these lines: + + ... + + import sys + import os + import platform + + if platform.architecture()[0] == "64bit": + sysdir = "stdlib64" + else: + sysdir = "stdlib" + + sys.path.insert(0, os.path.join(os.path.dirname(__file__), "box", sysdir)) + os.environ['PATH'] = os.environ['PATH'] + ";." + + ... + + import traceback + import ctypes + import threading + + importError = False + + try: + from box import box, sim_info, win32con + except: + ac.log('BoxApp: error loading modules: ' + traceback.format_exc()) + importError = True + + + ... + +## KNOWN ISSUES + +- newupdate and install_zip don't work + +## CHANGELOG + +### v0.2 + +- class SoundPlayer is now working + +### v0.1.3 + +- first attempt to make newupdate() work + +### v0.1.2 + +- reworked functions (check Wiki page) + +### v0.1.1 + +- added getZipFile function