Difference between revisions of "Compo4All"

From Pandora Wiki
Jump to: navigation, search
(Compo4All introduction)
 
m (Hack to make permissible values show properly.)
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
Compo4All is an gaming competition system designed by Skeezix.
  
−
= Compo4All =
+
The initial system was based on a MAME build where highscores were uploaded to a website, but has since expanded to include native Pandora games ([[PND]]) as well.
−
Compo4All is an gaming competition system designed by Skeezix. The initial system was based on a MAME build where highscores were uploaded to a website, but has since expanded to include a few indie games.
 
  
  
 
== Platforms ==
 
== Platforms ==
−
Currently, the only supported platform is the Pandora, but there are thoughts about expanding it to the Raspberry Pi, and desktop environments
+
Currently, the only supported platform is the Pandora, but there are thoughts about expanding it to the Raspberry Pi, and desktop environments.
  
 +
There is an unofficial port of C4A for the GCW and Caanoo. However at the moment only a few games (no MAME) are supported yet.
  
 
== Launchers ==
 
== Launchers ==
 
* Skeezix's [http://repo.openpandora.org/?page=detail&app=compo4all-skeezix-0001 Compo4All MAME] ([http://boards.openpandora.org/index.php/topic/12127-release-compo4all-mame-ladderscoreboard-competition-for-classic-arcade-games/ Forum Thread])
 
* Skeezix's [http://repo.openpandora.org/?page=detail&app=compo4all-skeezix-0001 Compo4All MAME] ([http://boards.openpandora.org/index.php/topic/12127-release-compo4all-mame-ladderscoreboard-competition-for-classic-arcade-games/ Forum Thread])
−
* Skeezix's Profile Manager (Not yet available)
+
* Skeezix's [http://repo.openpandora.org/?page=detail&app=compo4all-mgr-skeezix-0001 Compo4All Manager] ([http://boards.openpandora.org/index.php/topic/13742-c4a-manager-now-on-repo-beta-please-test-it-create-your-c4a-profile-without-using-c4a-mame-now/#entry260224 Forum Thread])
−
* [http://pandorawiki.org/User:Pmprog pmprog's] Tournament Hub (Not yet available) ([http://boards.openpandora.org/index.php/topic/12745-pandora-compo4all-ui/ Forum Thread])
+
* [http://pandorawiki.org/User:Pmprog pmprog's] [http://repo.openpandora.org/?page=detail&app=thetournamenthub.marqwatkin Tournament Hub] ([http://boards.openpandora.org/index.php/topic/12745-pandora-compo4all-ui/ Forum Thread])
 +
* Ziz's [http://repo.openpandora.org/?page=detail&app=Sparrow-C4A-Manager-1337 Sparrow C4A Manager] ([http://boards.openpandora.org/topic/14104-sparrow-compo4all-manager-and-puzzletube-c4a-edition-betas Forum Thread])
  
 +
== Scoreboard ==
 +
Scores are shown within the three launchers, but are also accessible via a web browser at [http://c4a.openpandora.org/ http://c4a.openpandora.org]
 +
 +
== Developers SDK ==
 +
 +
There are two ways of developing C4A stuff at the moment. First of all the official way from skeezix. Details of the official API for integrating with the Compo4All system can be found [[Compo4AllSDK|here]].
 +
 +
The second way is to use libSparrowNet, an independent library from Ziz, which encapsulate the network stuff with background thread and multi platform support. Details can be found [[Using_C4A_with_libSparrowNet|here]].
 +
 +
== Publishing a game to the servers ==
 +
 +
Given that a game supports compo4all (pushes scores to it, say), a few steps remain.
 +
 +
  - the compo4all server must be told about the game, via a config file submitted to skeezix (at the openpandora boards)
 +
  - ideally, the http://c4a.openpandora.org/ website needs to have some marquee artwork (send an image to milkshake at the openpandora boards)
 +
 +
A config file example (pulled from current indie game) is below; the values shoudl be more or less self explanatory, but I realize at this time this isn't a great deal of information; please ask if you're confused about the syntax or acceptible values and I'll update this page!
 +
 +
Sample config file:
  
−
== Scoreboard ==
+
    {
−
Scores are shown within the two launchers, but are also accessible via a [http://c4a.openpandora.org/ web browser]
+
    "active": true,
 +
    "plugin": "scoreonly",
 +
    "module": null,
 +
    "alltime": true,
 +
    "platforms": [ "pandora" ],
 +
    "league": "all",
 +
    "shortname": "mygame",
 +
    "longname": "My Game!",
 +
    "ordering": "highest-first",
 +
    "dispunit": "points",
 +
    "type": "int",
 +
    "field": "indie",
 +
    "genre": "logic",
 +
    "execinfo": {
 +
      "pandora": {
 +
        "type": "standalone",
 +
        "pnd_unique_id": "mygame.skeezix.001",
 +
        "last_known_filename_hint": "mygame.pnd",
 +
        "command_line_add": "",
 +
        "last_known_appdata_hint": "mygame",
 +
        "file_dependancies_hint": ""
 +
        }
 +
      }
 +
    }
  
 +
Permissible values..
  
−
== Developers SDK ==
+
    ordering: lowest-first highest-first
−
Details of the API for integrating with the Compo4All system can be found [[Compo4AllSDK|here]]
+
    type: standalone
 +
    league: all
 +
    field: indie arcade
 +
    genre: logic strategy racing action shmup runngun

Latest revision as of 23:24, 3 June 2016

Compo4All is an gaming competition system designed by Skeezix.

The initial system was based on a MAME build where highscores were uploaded to a website, but has since expanded to include native Pandora games (PND) as well.


Platforms

Currently, the only supported platform is the Pandora, but there are thoughts about expanding it to the Raspberry Pi, and desktop environments.

There is an unofficial port of C4A for the GCW and Caanoo. However at the moment only a few games (no MAME) are supported yet.

Launchers

Scoreboard

Scores are shown within the three launchers, but are also accessible via a web browser at http://c4a.openpandora.org

Developers SDK

There are two ways of developing C4A stuff at the moment. First of all the official way from skeezix. Details of the official API for integrating with the Compo4All system can be found here.

The second way is to use libSparrowNet, an independent library from Ziz, which encapsulate the network stuff with background thread and multi platform support. Details can be found here.

Publishing a game to the servers

Given that a game supports compo4all (pushes scores to it, say), a few steps remain. 

 - the compo4all server must be told about the game, via a config file submitted to skeezix (at the openpandora boards)
 - ideally, the http://c4a.openpandora.org/ website needs to have some marquee artwork (send an image to milkshake at the openpandora boards)

A config file example (pulled from current indie game) is below; the values shoudl be more or less self explanatory, but I realize at this time this isn't a great deal of information; please ask if you're confused about the syntax or acceptible values and I'll update this page!

Sample config file: 

   {
   "active": true,
   "plugin": "scoreonly",
   "module": null,
   "alltime": true,
   "platforms": [ "pandora" ],
   "league": "all",
   "shortname": "mygame",
   "longname": "My Game!",
   "ordering": "highest-first",
   "dispunit": "points",
   "type": "int",
   "field": "indie",
   "genre": "logic",
   "execinfo": {
     "pandora": {
       "type": "standalone",
       "pnd_unique_id": "mygame.skeezix.001",
       "last_known_filename_hint": "mygame.pnd",
       "command_line_add": "",
       "last_known_appdata_hint": "mygame",
       "file_dependancies_hint": ""
       }
     }
   }

Permissible values.. 

   ordering: lowest-first highest-first
   type: standalone
   league: all
   field: indie arcade
   genre: logic strategy racing action shmup runngun
Retrieved from "https://pandorawiki.org/index.php?title=Compo4All&oldid=30182"