Revise docs
This commit is contained in:
parent
14c06fec57
commit
a024f7a1f9
39
README.rst
39
README.rst
|
@ -1,23 +1,23 @@
|
||||||
Slacker
|
Slacker
|
||||||
=======
|
=======
|
||||||
|
|
||||||
**Slacker** is a clone/parody of the popular arcade game *Stacker*, in which
|
Slacker is a clone/parody of the popular arcade game Stacker_, in which
|
||||||
you must stack blocks to the top of the screen in order to win the game. Boxes
|
you must stack blocks to the top of the screen in order to win the game.
|
||||||
will move back and forth at varying speeds. Press Space to stop the boxes and
|
Boxes will move back and forth at varying speeds. Press Space
|
||||||
move on to the next row. Only boxes that have something underneath them will be
|
to stop the boxes and move on to the next row. Only boxes that have
|
||||||
stacked. As the tower rises, the game will make your tower thinner. You win a
|
something underneath them will be stacked. As the tower rises, the game
|
||||||
minor prize at the 10th level (the blocks change color), and if you reach the
|
will make your tower thinner. You win a minor prize at the 10th level
|
||||||
15th level, you will win the major prize. Good luck!
|
(the blocks change color), and if you reach the 15th level, you will win
|
||||||
|
the major prize. Good luck!
|
||||||
|
|
||||||
This game and the above description was originally written by Clint and
|
This game and the above description was originally written by Clint
|
||||||
Jennifer Herron. I forked the game to improve the codebase, make it more
|
and Jennifer Herron. I forked the game to improve the codebase,
|
||||||
similar to the arcade game and hopefully add more features.
|
make it more similar to the arcade game and hopefully add more features.
|
||||||
|
|
||||||
Installation
|
Installation
|
||||||
------------
|
------------
|
||||||
|
|
||||||
**Slacker** can run on both Python 2 and 3. You can install it using ``pip`` or
|
Slacker can run on both Python 2 and 3. You can install it using ``pip``.
|
||||||
run ``./setup.py install --user``.
|
|
||||||
|
|
||||||
Control
|
Control
|
||||||
-------
|
-------
|
||||||
|
@ -37,8 +37,13 @@ Escape, ``q``
|
||||||
Credits
|
Credits
|
||||||
-------
|
-------
|
||||||
|
|
||||||
* `Original version <http://www.pyweek.org/e/LastMinute/>`_ by Clint
|
* `Original version`_ by Clint "HanClinto" Herron (coding)
|
||||||
"HanClinto" Herron (coding) and Jennifer Herron (graphics)
|
and Jennifer Herron (graphics)
|
||||||
* `VT323 font <https://fonts.google.com/specimen/VT323>`_ by Peter Hull
|
* `VT323 font`_ by Peter Hull and Jacques Le Bailly
|
||||||
* `Tango color palette <http://tango.freedesktop.org/Tango_Icon_Theme_Guidelines#Color_Palette>`_
|
* `Tango color palette`_ by the Tango Desktop Project
|
||||||
by Tango Desktop Project
|
|
||||||
|
.. _Stacker: https://en.wikipedia.org/wiki/Stacker_(arcade_game)
|
||||||
|
.. _Original version: http://www.pyweek.org/e/LastMinute/
|
||||||
|
.. _VT323 font: https://github.com/phoikoi/VT323
|
||||||
|
.. _Tango color palette:
|
||||||
|
https://en.wikipedia.org/wiki/Tango_Desktop_Project#Palette
|
||||||
|
|
|
@ -18,14 +18,8 @@ classifiers = [
|
||||||
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
|
'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
|
||||||
'Natural Language :: English',
|
'Natural Language :: English',
|
||||||
'Operating System :: OS Independent',
|
'Operating System :: OS Independent',
|
||||||
'Programming Language :: Python :: 3.5',
|
'Programming Language :: Python',
|
||||||
'Programming Language :: Python :: 3.6',
|
|
||||||
'Programming Language :: Python :: 3.7',
|
|
||||||
'Programming Language :: Python :: 3.8',
|
|
||||||
'Programming Language :: Python :: 3.9',
|
|
||||||
'Programming Language :: Python :: 3 :: Only',
|
|
||||||
'Topic :: Games/Entertainment :: Arcade']
|
'Topic :: Games/Entertainment :: Arcade']
|
||||||
requires-python = '>=3.6'
|
|
||||||
keywords = 'stacker,arcade-game,pygame'
|
keywords = 'stacker,arcade-game,pygame'
|
||||||
license = 'GPLv3+'
|
license = 'GPLv3+'
|
||||||
|
|
||||||
|
|
|
@ -1,92 +0,0 @@
|
||||||
Copyright 2011, The VT323 Project Authors (peter.hull@oikoi.com)
|
|
||||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
|
||||||
This license is copied below, and is also available with a FAQ at:
|
|
||||||
http://scripts.sil.org/OFL
|
|
||||||
|
|
||||||
|
|
||||||
-----------------------------------------------------------
|
|
||||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
|
||||||
-----------------------------------------------------------
|
|
||||||
|
|
||||||
PREAMBLE
|
|
||||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
|
||||||
development of collaborative font projects, to support the font creation
|
|
||||||
efforts of academic and linguistic communities, and to provide a free and
|
|
||||||
open framework in which fonts may be shared and improved in partnership
|
|
||||||
with others.
|
|
||||||
|
|
||||||
The OFL allows the licensed fonts to be used, studied, modified and
|
|
||||||
redistributed freely as long as they are not sold by themselves. The
|
|
||||||
fonts, including any derivative works, can be bundled, embedded,
|
|
||||||
redistributed and/or sold with any software provided that any reserved
|
|
||||||
names are not used by derivative works. The fonts and derivatives,
|
|
||||||
however, cannot be released under any other type of license. The
|
|
||||||
requirement for fonts to remain under this license does not apply
|
|
||||||
to any document created using the fonts or their derivatives.
|
|
||||||
|
|
||||||
DEFINITIONS
|
|
||||||
"Font Software" refers to the set of files released by the Copyright
|
|
||||||
Holder(s) under this license and clearly marked as such. This may
|
|
||||||
include source files, build scripts and documentation.
|
|
||||||
|
|
||||||
"Reserved Font Name" refers to any names specified as such after the
|
|
||||||
copyright statement(s).
|
|
||||||
|
|
||||||
"Original Version" refers to the collection of Font Software components as
|
|
||||||
distributed by the Copyright Holder(s).
|
|
||||||
|
|
||||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
|
||||||
or substituting -- in part or in whole -- any of the components of the
|
|
||||||
Original Version, by changing formats or by porting the Font Software to a
|
|
||||||
new environment.
|
|
||||||
|
|
||||||
"Author" refers to any designer, engineer, programmer, technical
|
|
||||||
writer or other person who contributed to the Font Software.
|
|
||||||
|
|
||||||
PERMISSION & CONDITIONS
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
|
||||||
redistribute, and sell modified and unmodified copies of the Font
|
|
||||||
Software, subject to the following conditions:
|
|
||||||
|
|
||||||
1) Neither the Font Software nor any of its individual components,
|
|
||||||
in Original or Modified Versions, may be sold by itself.
|
|
||||||
|
|
||||||
2) Original or Modified Versions of the Font Software may be bundled,
|
|
||||||
redistributed and/or sold with any software, provided that each copy
|
|
||||||
contains the above copyright notice and this license. These can be
|
|
||||||
included either as stand-alone text files, human-readable headers or
|
|
||||||
in the appropriate machine-readable metadata fields within text or
|
|
||||||
binary files as long as those fields can be easily viewed by the user.
|
|
||||||
|
|
||||||
3) No Modified Version of the Font Software may use the Reserved Font
|
|
||||||
Name(s) unless explicit written permission is granted by the corresponding
|
|
||||||
Copyright Holder. This restriction only applies to the primary font name as
|
|
||||||
presented to the users.
|
|
||||||
|
|
||||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
|
||||||
Software shall not be used to promote, endorse or advertise any
|
|
||||||
Modified Version, except to acknowledge the contribution(s) of the
|
|
||||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
|
||||||
permission.
|
|
||||||
|
|
||||||
5) The Font Software, modified or unmodified, in part or in whole,
|
|
||||||
must be distributed entirely under this license, and must not be
|
|
||||||
distributed under any other license. The requirement for fonts to
|
|
||||||
remain under this license does not apply to any document created
|
|
||||||
using the Font Software.
|
|
||||||
|
|
||||||
TERMINATION
|
|
||||||
This license becomes null and void if any of the above conditions are
|
|
||||||
not met.
|
|
||||||
|
|
||||||
DISCLAIMER
|
|
||||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
|
||||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
|
||||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
||||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
|
||||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
||||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
|
||||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
|
|
@ -1,6 +1,7 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
# A clone of the arcade game Stacker
|
# A clone of the arcade game Stacker
|
||||||
# Copyright (C) 2007 Clint Herron
|
# Copyright (C) 2007 Clint Herron
|
||||||
# Copyright (C) 2017, 2020 Nguyễn Gia Phong
|
# Copyright (C) 2017-2020 Nguyễn Gia Phong
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
# it under the terms of the GNU General Public License as published by
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
|
Loading…
Reference in New Issue