Skip to content

Latest commit

 

History

History
132 lines (117 loc) · 7.62 KB

README.md

File metadata and controls

132 lines (117 loc) · 7.62 KB
Raw

CPPS-PCL

A Penguin Client Library for Club Penguin Private Servers written in Python.

Warning: High ban risk - Do not use with your own main penguin.

This PCL contains an API, alongside two CLI interactive modes:

1. Single-Login

A simple login with one penguin.

2. Multi-Login

A complex login with multiple penguins managed by a certain shape.

Requirements

  • Python 2.x
  • Internet connection
  • For Club Penguin Rewritten: cefpython (can be installed with: pip install cefpython3)

Usage

API

TODO

Single-Login

  1. Run login.py:
python login.py [-r yes|no|ask] [<cpps>] [<server>] [<username>]

Options:
	-r  Remember password in the future
  1. Choose a server (if you didn't do that in the command line)
  2. Enter your username and password (if you didn't do that in the command line)
  3. Choose a server (if you didn't do that in the command line)
  4. Waddle on!

Multi-Login

  1. Run multi.py:
python multi.py [-r yes|no|ask] [<cpps>] [<server>] [<shape>]

Options:
	-r  Remember password in the future
  1. Choose a server (if you didn't do that in the command line)
  2. Choose a shape (defined in json/shapes.json, if you didn't do that in the command line)
  3. Enter your usernames and passwords (as many as needed for the shape)
  4. Waddle on!

Interactive Commands

Mode Command Parameters Description
Both help None Prints "HELP" (will be implemented in the future).
Single-Login only log None Toggles logging on/off.
Single-Login only log level Sets logging level to level.
level must be one of the following:
  • all - Logs all messages below.
  • debug - Logs debug messages such as sent and received packets, and below.
  • info - Logs higher-level messages such as walking, talking etc., and below.
  • warning - Logs warning messages such as unhandled packets, and below.
  • error - Logs failure messages such as "Could not add item", and below (default).
  • critical - Logs fatal error messages such as "Connection lost".
Both internal None Prints current internal room ID.
Single-Login only id None Prints current penguin ID.
Both id penguin_name... Prints ID of penguin(s) named penguin_name.
Both name None Prints current penguin name.
Both name penguin_id... Prints name of penguin(s) with ID penguin_id.
Both room None Prints current room name.
Both room room_id Goes to room with ID room_id.
Both room room_name Goes to room named room_name.
Single-Login only igloo None Goes to your igloo.
Both igloo penguin_id Goes to igloo of penguin with ID penguin_id.
Both igloo penguin_name Goes to igloo of penguin named penguin_name.
Single-Login only penguins None Lists all penguins in current room.
Both color None Prints current color item ID.
Both color item_id Equips color item with ID item_id.
Both head None Prints current head item ID.
Both head item_id Equips head item with ID item_id.
Both face None Prints current face item ID.
Both face item_id Equips face item with ID item_id.
Both neck None Prints current neck item ID.
Both neck item_id Equips neck item with ID item_id.
Both body None Prints current body item ID.
Both body item_id Equips body item with ID item_id.
Both hand None Prints current hand item ID.
Both hand item_id Equips hand item with ID item_id.
Both feet None Prints current feet item ID.
Both feet item_id Equips feet item with ID item_id.
Both pin None Prints current pin item ID.
Both pin item_id Equips pin item with ID item_id.
Both background None Prints current background item ID.
Both background item_id Equips background item with ID item_id.
Single-Login only clothes None Prints all current item IDs.
Both clothes penguin_id... Prints all current item IDs of penguin(s) with ID penguin_id.
Both clothes penguin_name... Prints all current item IDs of penguin(s) named penguin_name.
Both inventory None Prints current inventory.
Single-Login only buddies None Prints current buddies.
Single-Login only stamps None Prints all earned stamps.
Single-Login only stamps penguin_id... Prints all earned stamps by penguin(s) with ID penguin_id.
Single-Login only stamps penguin_name... Prints all earned stamps by penguin(s) named penguin_name.
Both walk x y Walks to (x, y).
Both dance None Dances.
Both wave None Waves.
Both sit None Sits in direction South.
Both sit direction Sits in direction direction.
direction must be one of the following:
  • se - South East.
  • e - East.
  • ne - North East.
  • n - North.
  • nw - North West.
  • w - West.
  • sw - South West.
  • s - South.
Both snowball x y Throws a snowball to (x, y).
Both say message... Says message.
Both joke joke_id Tells joke with ID joke_id.
Both emote emote_id Reacts emote with ID emote_id.
Both mail penguin_id postcard_id Sends to a penguin with ID penguin_id a postcard with ID postcard_id.
Both mail penguin_name postcard_id Sends to a penguin named penguin_name a postcard with ID postcard_id.
Both buy item_id... Buys item(s) with ID item_id.
Both ai item_id... Buys item(s) with ID item_id.
Both coins None Prints current coins.
Both coins amount Earns amount coins.
Both ac amount Earns amount coins.
Both stamp stamp_id... Earns stamp(s) with ID stamp_id.
Both add_igloo igloo_id... Buys igloo(s) with ID igloo_id.
Both add_furniture... furniture_id Buys furniture(s) with ID furniture_id.
Both music music_id Sets igloo music to music_id.
Both buddy penguin_id... Sends a buddy request to penguin(s) with ID penguin_id.
Both buddy penguin_name... Sends a buddy request to penguin(s) named penguin_name.
Single-Login only find penguin_id... Finds room of buddy/buddies with ID penguin_id.
Single-Login only find penguin_name... Finds room of buddy/buddies named penguin_name.
Single-Login only follow None Prints currently followed penguin.
Both follow penguin_id Follows a penguin with ID penguin_id.
Both follow penguin_name Follows a penguin named penguin_name.
Both follow penguin_id dx dy Follows a penguin with ID penguin_id with offset (dx, dy).
Both follow penguin_name dx dy Follows a penguin named penguin_name with offset (dx, dy).
Both unfollow None Stops following.
Both logout None Logouts from the game.
Both exit None Logouts from the game.
Both quit None Logouts from the game.

Tips and Tricks

  • Define more CPPSs and servers in json/servers.json
  • Define more shapes in json/shapes.json