Skip to content
Permalink
Browse files

Merge branch 'release-1.6'

  • Loading branch information...
alexanderkress committed Apr 3, 2016
2 parents 58c3554 + b6e4410 commit 7e1582f0618efa495a77559c3813468853415055
Showing with 306 additions and 113 deletions.
  1. +12 −0 .gitignore
  2. +1 −1 LICENSE
  3. +8 −0 MANIFEST.in
  4. +30 −9 README.md
  5. +3 −0 conf/settings.conf
  6. +3 −1 doc/Commands.md
  7. BIN lib/GeoIP.dat
  8. +1 −1 lib/MIT_LICENSE
  9. +9 −0 setup.cfg
  10. +97 −0 setup.py
  11. +142 −101 spunky.py
@@ -2,6 +2,11 @@
*.py[co]
__pycache__

# build products
build
dist
spunkybot.egg-info

# SVN
.svn/

@@ -18,8 +23,15 @@ __pycache__
# Backup files
*.*~

# Swap files
*.sw[po]

# Test files
test*.*

# Log files
*.log

# Vagrant
Vagrantfile
.vagrant/
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2013-2015 Spunky Bot
Copyright (c) 2013-2016 Spunky Bot

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
@@ -0,0 +1,8 @@
include README.md LICENSE
include lib/GeoIP.dat
recursive-include conf *.conf
recursive-include doc *.md
include debian-startscript
exclude setup.py
exclude setup.cfg
exclude MANIFEST.in
@@ -1,16 +1,17 @@
This README is just a quick start document. You can find more detailed documentation at [https://spunkybot.de](https://spunkybot.de).
This README is just a quick start document. You can find more detailed documentation of Spunky Bot at [https://spunkybot.de](https://spunkybot.de).

# What is Spunky Bot?

**Spunky Bot** is a lightweight game server administration bot and RCON tool.
Its purpose is to administrate an [Urban Terror](http://www.urbanterror.info) 4.1 / 4.2 server and to provide real time statistical data for players.
Spunky Bot offers in-game commands without authentication and automated administration even when no admin is online.
Its purpose is to administer, manage and maintain an [Urban Terror](http://www.urbanterror.info) 4.1 / 4.2 server and to provide real time statistical data for players.
Spunky Bot is a cross-platform package and offers in-game commands without authentication and automated administration even when no admin is online.
The code of Spunky Bot is inspired by the eb2k9 bot by Shawn Haggard, which was released under the Beerware License.

[![Build Status](https://travis-ci.org/SpunkyBot/spunkybot.png?branch=master)](https://travis-ci.org/SpunkyBot/spunkybot)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/SpunkyBot/spunkybot/blob/master/LICENSE)
![Version](https://img.shields.io/badge/version-1.6.0-orange.svg)
[![PyPI version](https://img.shields.io/pypi/v/spunkybot.svg)](https://pypi.python.org/pypi/spunkybot)
[![Code Health](https://landscape.io/github/SpunkyBot/spunkybot/master/landscape.svg)](https://landscape.io/github/SpunkyBot/spunkybot/master)
![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Version](https://img.shields.io/badge/version-1.5.0-orange.svg)

If you want to know more, this is a list of selected starting points:

@@ -34,8 +35,8 @@ If you want to know more, this is a list of selected starting points:
- Urban Terror 4.1.1 and 4.2.023
- Python 2.6.x / 2.7.x
- SQLite 3 database
- Linux platform (tested on Debian 6 & 7, Ubuntu 12 & 14, CentOS 6.5 and Mac OS X 10.10)
- Supporting Linux 32-bit and 64-bit operating system
- Cross-platform (tested on Debian 6 / 7 / 8, Ubuntu 12 / 14, CentOS 6.5 / 7.1, Mac OS X 10.11, Windows 7 / 10)
- Supporting 32-bit and 64-bit operating systems


## Quickstart
@@ -89,14 +90,30 @@ For additional information, visit the Spunky Bot website at [https://www.spunkyb

If you have any questions about Spunky Bot or need help, please use the [mailing list](https://groups.google.com/group/spunkybot) or post the question on our [forum](http://forum.spunkybot.de). If you need help right now, you can also find us on [Twitter](https://twitter.com/spunkybot).

* Joining the mailing list:
* Send an email to <mailto:spunkybot+subscribe@googlegroups.com>
* or subscribe via web: [https://groups.google.com/forum/#!forum/spunkybot/join](https://groups.google.com/forum/#!forum/spunkybot/join)
* Leaving the mailing list:
* Send an email to <mailto:spunkybot+unsubscribe@googlegroups.com>
* or unsubscribe via web: [https://groups.google.com/forum/#!forum/spunkybot/unsubscribe](https://groups.google.com/forum/#!forum/spunkybot/unsubscribe)
* If you joined the group, you can post to this group:
* Send an email to <spunkybot@googlegroups.com>

In our [Google+ Community](https://plus.google.com/communities/116728939500870368885) we talk about anything our community is interested in. You can also follow us on [Google+](https://plus.google.com/106857192050943115434).

If you have bug reports or feature suggestions, please use the [issue tracker](https://github.com/SpunkyBot/spunkybot/issues?state=open).


## Contributing
You can help us in different ways:

* Open an [issue](https://github.com/SpunkyBot/spunkybot/issues) with suggestions for improvements
* Fork this repository and submit a pull request
* Fork this repository and submit a pull request:
* Click the Fork button to create your personal fork
* Create your feature branch (`git checkout -b new-feature`)
* Commit your changes (`git commit -am 'Add some feature'`)
* Push to the branch (`git push origin new-feature`)
* Create a new pull request
* Improve the [documentation](https://github.com/SpunkyBot/spunkybot-docs) (separate repository)

By contributing code to this project in any form, including sending a pull request via GitHub, a code fragment or patch via mail or public discussion groups, you agree to release your code under the terms of the MIT license that you can find in the [LICENSE](https://github.com/SpunkyBot/spunkybot/blob/master/LICENSE) file included in this source distribution.
@@ -114,4 +131,8 @@ The code of Spunky Bot is released under the MIT License. See the [LICENSE](http
- Schedule: [schedule.py](https://github.com/dbader/schedule)
- This file is released under the MIT License.

Urban Terror™ and FrozenSand™ are trademarks of 0870760 B.C. Ltd.
Urban Terror™ and FrozenSand™ are trademarks of 0870760 B.C. Ltd.


## Thank you!
We really appreciate all kinds of feedback and contributions. Thanks for using and supporting Spunky Bot!
@@ -20,6 +20,9 @@ show_hit_stats_respawn = 1 ; Enable (1) or disable (0)
autobalancer = 0 ; Enable (1) or disable (0) autobalancing of teams at the end of the round/match
allow_teams_round_end = 0 ; Enable (1) or disable (0) allowing command !teams only at end of the round/match
spam_bomb_planted = 1 ; Enable (1) or disable (0) spamming the message "Bomb has been planted" in global chat
spam_knife_kills = 0 ; Enable (1) or disable (0) displaying player's knife kill series as bigtext
spam_nade_kills = 0 ; Enable (1) or disable (0) displaying player's HE grenade kill series as bigtext
spam_headshot_hits = 1 ; Enable (1) or disable (0) displaying player's headshot hit series as bigtext
verbose = 0 ; Enable (1) or disable (0) debug messages

[mapcycle]
@@ -29,6 +29,8 @@
- Usage: `!freezestats`
- **hestats** - display HE grenade kill stats
- Usage: `!hestats`
- **knife** - display knife kill stats
- Usage: `!knife`
- **hits** - display hit stats
- Usage: `!hits`
- **teams** - balance teams
@@ -110,7 +112,7 @@
- **warnclear** - clear the user warnings
- Usage: `!warnclear <name>`
- Short: `!wc <name>`
- **tempban** - ban a player temporary for the given period
- **tempban** - ban a player temporary for the given period (1 min to 24 hrs)
- Usage: `!tempban <name> <duration> [<reason>]`
- Short: `!tb <name> <duration> [<reason>]`
- Max ban duration: 24 hours
BIN +85.3 KB (110%) lib/GeoIP.dat
Binary file not shown.
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2013 urthub
Copyright (c) 2013-2016 Spunky Bot

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
@@ -0,0 +1,9 @@
[metadata]
description-file = README.md
license-file = LICENSE

[sdist]
formats=zip,gztar

[bdist_wheel]
python-tag = py27
@@ -0,0 +1,97 @@
#!/usr/bin/env python

import sys
import re

try:
from setuptools import setup, find_packages
except ImportError:
print('Spunky Bot needs setuptools in order to build. Install it using'
' your package manager (usually python-setuptools) or via pip (pip'
' install setuptools).')
sys.exit(1)

if sys.version_info < (2, 6):
raise NotImplementedError('Sorry, you need at least Python 2.6.')

metadata = dict(re.findall("__([a-z]+)__ = '([^']+)'", open('spunky.py').read()))

long_description = """Overview
========
Spunky Bot is a lightweight game server administration bot and RCON tool.
Its purpose is to administer, manage and maintain an `Urban Terror`_ server and
to provide real time statistical data for players.
Spunky Bot is a cross-platform package and offers in-game commands without
authentication and automated administration even when no admin is online.
Your gameserver can be enhanced with the ultimate administration power that
Spunky Bot brings! The all-in-one server administration bot for Urban Terror
gives admins the power to easily manage and administrate their server.
It allows players access to statistics and gives powerful options to manage
the flow of a game.
Spunky Bot is free and open source, released under the MIT_ license.
There are no software requirements, Spunky Bot is running "out of the box".
The installation is just click and go. There is no need to install a heavy
MySQL database, SQLite is used to boost up the performance and to reduce the
memory footprint.
Features
========
* Lightweight and fast
* Real time game statistics
* Different user groups and levels
* Supports all RCON commands
* Supports temporary and permanent bans of players
* Supports rotation messages
Installation
============
::
pip install spunkybot
See the Homepage_ for usage and documentation or visit the Git Repository_
for the source code.
.. _Urban Terror: http://www.urbanterror.info/
.. _MIT: http://opensource.org/licenses/MIT
.. _Homepage: http://spunkybot.de/
.. _Repository: https://github.com/spunkybot/spunkybot/
"""

setup(name='spunkybot',
version=metadata['version'],
description='An automated game server bot and RCON tool for Urban Terror',
long_description=long_description,
author='Alexander Kress',
author_email='feedback@spunkybot.de',
url='http://spunkybot.de/',
keywords='Urban Terror Game Administration RCON Bot',
download_url='http://github.com/spunkybot/spunkybot/tarball/master',
license='MIT',
install_requires=['setuptools'],
py_modules=['spunky'],
package_dir={'conf': 'conf', 'lib': 'lib'},
packages=find_packages(exclude=['tests*']),
classifiers=[
'Development Status :: 5 - Production/Stable',
'Environment :: Console',
'Intended Audience :: Developers',
'Intended Audience :: System Administrators',
'License :: OSI Approved :: MIT License',
'Natural Language :: English',
'Operating System :: OS Independent',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Topic :: System :: Logging',
'Topic :: System :: Monitoring',
'Topic :: System :: Systems Administration',
'Topic :: Games/Entertainment',
'Topic :: Utilities',
],
data_files=[('', ['debian-startscript', 'README.md', 'LICENSE']),
('lib', ['lib/GeoIP.dat'])],
)
Oops, something went wrong.

0 comments on commit 7e1582f

Please sign in to comment.
You can’t perform that action at this time.