Package: torille
ToriLLEToribash Learning Environment. Extra "L" to make words more memorable for Finns ("Torille" = "To the marketplace").ToriLLE provides learning agents an interface to video-gameToribash, a humanoid fighting game.
Toribash provides environment for MuJoCo-like humanoid control, specifically aimed for competitive gameplay. This makes
ToriLLE suitable for e.g. self-play experiments.ToriLLE comes with a Python interface and pre-made OpenAI Gym environment with various tasks. Following white-paper includes baseline experiments and benchmarks conducted using ToriLLE:https://arxiv.org/abs/1807.10110RequirementsTested to work on Windows 10, Ubuntu 16.04 and MacOS 10.13. Tested on Python versions 3.5 and 3.6, and will likely not work on 2.7.Numpy (Python)FileLock (Python)Wine(For Linux/MacOS.Requires modern version. Tested on 3.0.3)QuickstartRemember to installWineif you are on Linux or MacOS. Make surewinecommand is defined.Following will download ToriLLE with stripped down version of Toribash:pip install torilleRandom agent:fromtorilleimportToribashControlfromtorille.utilsimportcreate_random_actions# Show gameplaytoribash=ToribashControl(draw_game=True)toribash.init()# Random agentwhile1:state,t=toribash.get_state()ift:breaktoribash.make_actions(create_random_actions())toribash.close()OpenAI Gym environment:importgymimporttorille.envsenv=gym.make("Toribash-DestroyUke-v0")# Show gameplayenv.set_draw_game(True)initial_state=env.reset()t=False# Random agentwhilenott:s,r,t,_=env.step(env.action_space.sample())env.close()Manual installationYou can install ToriLLE without PyPI/pip with the following:InstallToribash(note: Only Steam version may be up to date)Copy contents oftoribash-codesto Toribash installation directory. Overwrite filesNote:This will prevent using that specific installation as a regular game. Remove/renameprofile.tbsfile
to revert most of the changes and use game normally again.Note2:Starting with Toribash 5.4 / Steam version of Toribash, settings file is stored in under user's directory atSaved Games/Toribash/custom.cfg. Toribash loads this file by default if it finds it, which may cause
ToriLLE to run in wrong settings.Provide path the installedtoribash.exewhen creatingToribashControlobjects (if you use provided Python library)Playing in multiplayerNote: Multiplayer does not work on Linux Wine!Want to try your agents against human players in multiplayer? Check howmanual remote controlworks.DocumentationExamples inexamplesprovide quickstart to how to use ToriLLE, and also show how to apply settings or
record replays.For references see:Python libraryGym environmentFor troubleshooting, see theFAQ.If you wish to modify ToriLLE or use other language to control Toribash instance, seehackinganddocumentation on protocol.Repository structure./torille/: Python codes for the learning environment (inc. Gym environment)./torille/toribash: This will include stripped version of the Toribash game when installed from PyPi./toribash-codes/: Files required for Toribash to make this learning environment work./examples/: Python examples on how to use this library./docs/: Detailed documentation of the inner workings./experiments/: Codes used to run experiments in the white paper./images/: Contains GIFs used hereRelated work and useful linksOptions/chat rules:http://forum.toribash.com/showthread.php?t=317900Lua functions:https://github.com/trittimo/ToriScriptAPI/blob/master/docs/toribash_docs.txtBodypart list:http://forum.toribash.com/showthread.php?t=9391Previous experiments at machine learning with Toribash:http://forum.toribash.com/showthread.php?t=170100http://forum.toribash.com/showthread.php?t=167355http://forum.toribash.com/showthread.php?t=25263https://www.researchgate.net/profile/Jonathan_Byrne/publication/228848637_Optimising_offensive_moves_in_toribash_using_a_genetic_algorithm/links/0046351420d5001396000000.pdfCitingWe wouldn't mind a citation if you find ToriLLE useful in your work. It also helps us to see what people have been up to!@article{kanervisto2018torille,
  author = {Anssi Kanervisto and Ville Hautam{\"a}ki},
  title = {ToriLLE: Learning Environment for Hand-to-Hand Combat},
  year = {2018},
  journal = {arXiv preprint arXiv:1807.10110},
}Special thanks & Acknowledgementshampa and Dranix for invaluable help with configuring Toribash and lua scripts (also for developing the game in the first place!)Siim Põder (user "windo" on GitHub) for originaltoribash-evolvercodebox (Toribash user) for comments during inception of this projectLicenseCode original to ToriLLE is licensed under GNU GPL 3.0. Toribash is property of Nabistudios. Toribash binary in PyPI package is shared with the permission of main developer "hampa".