spring-chobby / chobby

Spring RTS Ingame lobby project

Chobby, the ingame lobby.

Installation

There are multiple ways you can install Chobby.

1. Chobby.exe wrapper (recommended)

Download chobby.exe from http://zero-k.info/lobby/chobby.exe and run it. It will download the newest version of Chobby as well as the required engine, and automatically start it. Should work under Windows and Linux.

2. Rapid (pr-downloader)

Chobby is on rapid, under the "chobby" tag.

To download with pr-downloader use this command line:

pr-downloader chobby:test

You will need to obtain the appropriate engine and configure it manually.

3. Development version from Github

The development version of Chobby can be obtained directly from here, and should be placed in your games subdirectory. Example (execute in your games folder):

git clone https://github.com/Spring-Chobby/Chobby.git Chobby.sdd

Launching

If you're using the wrapper, you don't need to read this. Just go ahead and run the executable.

Chobby is a Lua Menu and requires the newest engine. For exact version, see the engine tag in modinfo.lua (https://github.com/Spring-Chobby/Chobby/blob/master/modinfo.lua#L19).

For development version of Chobby (obtained from Github), you can launch Chobby by running spring --menu 'Chobby $VERSION' or by setting DefaultLuaMenu = Chobby $VERSION in your springsettings.cfg (https://springrts.com/wiki/Springsettings.cfg). Versions obtained from Github should follow the same procedure, but set the appropriate fixed version instead, e.g. Chobby test-1145-2d0ef36, instead of Chobby $VERSION.

If you are using chobby:test from rapid, you can specify rapid directly, instead of setting the version manually. e.g. spring --menu 'rapid://chobby:test' and DefaultLuaMenu = rapid://chobby:test

See the wiki for more details, including Game Customization

chobby's Issues

Optimize TextBox for multiline display, use a table of strings instead of one big string

The current large textbox system creates a lot of string concatenation and rendering.

Rapid pause, cancel and queue reordering

Implement the required engine functions:
VFS.PauseDownload(downloadID)
VFS.ResumeDownload(downloadID)
VFS.StopDownload(downloadID)
VFS.SetDownloadPriority(downloadID, priority)
VFS.GetDownloadPriority(downloadID) -> number priority

Disable the rectangle select from appearing

Unit selection is still visible/occurs and is just confusing

Duplicate DownloadFinished?

These two lines appear to be defining DownloadFinished twice:

• https://github.com/gajop/Chobby/blob/master/LuaUI/widgets/chobby/core.lua#L81
• https://github.com/gajop/Chobby/blob/master/LuaUI/widgets/gui_chili_lobby.lua#L52

Because of this:
https://github.com/gajop/Chobby/blob/master/LuaUI/widgets/chobby/core.lua#L43

I dislike the line "ChiliLobby = widget". This global variable should be off limits. Ideally the widget file would just be a wrapper widget and none of the included files would respond to Spring callins. The widget would wrap everything.

on login: "attempt to call field 'CalcMd5' (a nil value)"

when trying to login i get the error

"attempt to call field 'CalcMd5' (a nil value)"

pr-downloader API fails to download more than one archive

Complains about files being already open, etc.

Occasional list_window panel2 error

Sometimes this error occurs. I do not know what the effect of the error is.

[f=0057244] [liblobby] Error: [string "LuaUI/widgets/chobby/components/list_window..."]:164: attempt to index local 'panel2' (a nil value)
stack traceback:
[string "libs/liblobby/lobby/observable.lua"]:65: in function '_PrintError'
[string "libs/liblobby/lobby/observable.lua"]:59: in function <[string "libs/liblobby/lobby/observable.lua"]:59>
[string "LuaUI/widgets/chobby/components/list_window..."]:164: in function 'RecalculatePosition'
[string "LuaUI/widgets/chobby/components/list_window..."]:122: in function 'AddRow'
[string "LuaUI/widgets/chobby/components/battle/batt..."]:132: in function 'AddBattle'
[string "LuaUI/widgets/chobby/components/battle/batt..."]:9: in function 'listener'
[string "libs/liblobby/lobby/observable.lua"]:58: in function <[string "libs/liblobby/lobby/observable.lua"]:58>
[C]: in function 'xpcall'
[string "libs/liblobby/lobby/observable.lua"]:58: in function '_CallListeners'
[string "libs/liblobby/lobby/interface_zerok.lua"]:722: in function 'method'
[string "-- Copyright (c) 2012-2014 Roland Yonaba..."]:170: in function 'super'
...
[string "-- Copyright (c) 2012-2014 Roland Yonaba..."]:170: in function 'super'
[string "libs/liblobby/lobby/wrapper_zerok.lua"]:358: in function 'SafeUpdate'
[string "libs/liblobby/lobby/interface_shared.lua"]:207: in function <[string "libs/liblobby/lobby/interface_shared.lua"]:207>
[C]: in function 'xpcall'
[string "libs/liblobby/lobby/interface_shared.lua"]:207: in function 'Update'
[string "libs/liblobby/LuaUI/widgets/api_lobby.lua"]:66: in function <[string "libs/liblobby/LuaUI/widgets/api_lobby.lua"]:65>
(tail call): ?
[C]: in function 'pcall'
[string "LuaHandler/Utilities/crashHandler.lua"]:50: in function 'f'
[string "LuaHandler/Utilities/specialCallinHandlers...."]:80: in function <[string "LuaHandler/Utilities/specialCallinHandlers...."]:76>
[f=0057244] [liblobby] Error: [string "LuaUI/widgets/chobby/components/list_window..."]:164: attempt to index local 'panel2' (a nil value)
stack traceback:
[string "libs/liblobby/lobby/observable.lua"]:65: in function '_PrintError'
[string "libs/liblobby/lobby/observable.lua"]:59: in function <[string "libs/liblobby/lobby/observable.lua"]:59>
[string "LuaUI/widgets/chobby/components/list_window..."]:164: in function 'RecalculatePosition'
[string "LuaUI/widgets/chobby/components/battle/batt..."]:144: in function 'JoinedBattle'
[string "LuaUI/widgets/chobby/components/battle/batt..."]:19: in function 'listener'
[string "libs/liblobby/lobby/observable.lua"]:58: in function <[string "libs/liblobby/lobby/observable.lua"]:58>
[C]: in function 'xpcall'
[string "libs/liblobby/lobby/observable.lua"]:58: in function '_CallListeners'
[string "libs/liblobby/lobby/interface_zerok.lua"]:888: in function 'method'
[string "-- Copyright (c) 2012-2014 Roland Yonaba..."]:170: in function 'super'
[string "libs/liblobby/lobby/wrapper_zerok.lua"]:162: in function '_OnJoinedBattle'
...
[string "-- Copyright (c) 2012-2014 Roland Yonaba..."]:170: in function 'super'
[string "libs/liblobby/lobby/wrapper_zerok.lua"]:358: in function 'SafeUpdate'
[string "libs/liblobby/lobby/interface_shared.lua"]:207: in function <[string "libs/liblobby/lobby/interface_shared.lua"]:207>
[C]: in function 'xpcall'
[string "libs/liblobby/lobby/interface_shared.lua"]:207: in function 'Update'
[string "libs/liblobby/LuaUI/widgets/api_lobby.lua"]:66: in function <[string "libs/liblobby/LuaUI/widgets/api_lobby.lua"]:65>
(tail call): ?
[C]: in function 'pcall'
[string "LuaHandler/Utilities/crashHandler.lua"]:50: in function 'f'
[string "LuaHandler/Utilities/specialCallinHandlers...."]:80: in function <[string "LuaHandler/Utilities/specialCallinHandlers...."]:76>

Load Map/Game archive

It seems like we already have
VFS.UseArchive VFS.MapArchive VFS.UnmapArchive
but instead of working with files, they should use Map and Game archives that can be in .sd7, sdz, .sdd or in the rapid pool. The format is abstracted and the should be loaded by name, instead of having to know the correct path as it's currently implemented.

Create the Download panel

Should handle both rapid names and full archive names.
Initially we don't need search or game list (this will require some engine/pr-downloader changes)

Close chat overlaps scrollbar on window.

See the screenshot.

Alter UI for received messages and play a sound

Things to keep in mind:

• only do this if the current tab isn't focused.
• parse username in chat to detected messages directed to us

Make login window stay in front of all other windows.

Weird recursion(?) causing OOM

Happens sometimes, last one just happened as I launched Chobby

[f=-000001] Fatal: LuaUI: cannot allocate more memory! (805307079 bytes already used, 805306368 bytes maximum)
[f=-000001] Fatal: LuaUI: cannot allocate more memory! (805307079 bytes already used, 805306368 bytes maximum)
[f=-000001] Fatal: LuaUI: cannot allocate more memory! (805307079 bytes already used, 805306368 bytes maximum)
[f=-000001] Fatal: LuaUI: cannot allocate more memory! (805307079 bytes already used, 805306368 bytes maximum)
[f=-000001] Error: LuaUI::RunCallIn: error = 4, Update, [Internal Lua error: Call failure] not enough memory

Automatic login (as a checkbox in the initial menu)

Create username object

This is an object to replace the current buttons with usernames attached. It would consist of a control (probably panel or button) with stuff inside it. The purpose of the object is to have a consistent way to display and interact with user names across many types of user list. The stuff can then be defined in one place.

Possible stuff:

• A button with a dropdown menu for chat, invite to game, private message etc..
• Images for flag, rank etc...

Run Spring without specifying a map

Ability to run Spring without the map, rather than requiring a BlankMap.
This might also increase performance a bit.

Fix the current mainmenu->subtree navigation confusion

It has a number of issues:
1) There's no indication of where in menu tree you are. This should be done by introducing breadcrumbs or a fully visible tree (e.g. by using Content Place for the subtree like how Dota2/LoL do it). Breadcrumbs might not be clear and also too wide.
2) Exit button should be far away from other buttons, probably all the way in the bottom, so people don't press it accidentally.
3) Buttons should use fixed size, especially height (#68)
4) There is no indication to the user what button explores the subtree and what does something else, like open something in the Concent Place

I think it's key to get the basic interface going very early in the project.

Improve userlist panel with better user interaction

Dropdown menu for ignoring/sending friend request/initiating chat with users.
Single click shouldn't start chat, only double click should.
Make it impossible to chat with yourself.

Clicking on Skirmish/Queue/Custom game should close the existing and open a new window

Tab buttons should be fixed size and allow extra numbers(text) inside that indicate activity

Here's an example of how I think they should look: http://getbootstrap.com/components/#adapts-to-active-nav-states
This can be used for Chat, Downloads, Settings and My Battle.

upstream pr-downloader needs Download callins/callouts finished

Show that a user in private chat has gone offline

Restructure liblobby

Change the liblobby architecture:

• Implement a top-level, protocol class with a higher level of abstraction for shared datastructure, callins and callouts for ZK and uberserver. Essentially moving the wrapper classes here
• Make the current interface ZK and interface uber classes inherit from this class and add protocol-specific implementation to it.

Notifications when message directed to us has been received

We need to make the program flash/set the alarm state,and preferably also send an OS message (e.g. notify-send on Linux).
The type of thing to send depends on whether the program is opened or not, as well as whether the channel/private chat is focused(selected).

Automatically initiate downloads for missing maps and games in battlerooms

Required engine changes are split to a different issue now. This just includes the Lua stuff.

• Maybe show current download percentage, current/total size in MBs,
  eta, and similar
• Abstract the download panel outside of battleroom. It's really not
  specific to BRs and could be used as a chili component.
• Check for possible new download by invoking MaybeDownloadGame(battle) and
  MaybeDownloadMap(battle) when map/game changes.

Required engine changes

The following are engine changes required to make a decent ingame lobby:

• Spawn new engine instance instead of restarting (spring/spring@0155b5c)

List players, not all users (bots)

Ignore bots when displaying user numbers, and don't show bots in userlists

Rapid game and map search

Add ability to search for rapid games and maps based on either name and/or rapidname.
VFS.SearchArchives(searchString, archiveType)
with callins
OnSearchStart(searchID, searchString, archiveType)
OnSearchComplete(searchID, results)
OnSearchFailed(searchID, errorID)

Join/leave channels using buttons

There should be a + button somewhere in the chat panel, and clicking on it should make it possible to join a channel.
Also, channels should be closed when clicking on a corresponding X button.

Spring Subprocess tracking - basic functionality

We need to be able to know whether the started Spring subprocess has terminated or not.
A simple Spring.IsSubProcessAlive(subprocessPID) -> boolean isAlive, where subprocessPID is only valid if it's a previously started (from this instance) Spring subprocess

Allow Chili skins to be loaded from specific folder

This should allow us to create skins outside of the Chili folder and make it easier to use the library while keeping all project-specific stuff out of the library folder.
It shouldn't be too hard to do, but requires some internal Chili knowledge.
Here are how some example functions could look like:
SkinUtils:AddSkinFolder(folderPath)
SkinUtils:RemoveSkinFolder(folderPath)

Create Settings Screen

The settings screen should be in a tab on the right panel. It should include settings for ingame and settings for the lobby. These settings will need to be stored in a config and applied either just before Spring.Start or when the lobby is closed (to make the lobby have the right settings next time).

Function to return list of available AIs

Persist currently joined channels in configuration and rejoin them on login

• The channel list should be linked to the current server and user
• See the following on how to add new config, extend the save/load and invoke it:
  -- https://github.com/Spring-Chobby/Chobby/blob/master/LuaUI/widgets/chobby/components/configuration.lua#L12-L14
  -- https://github.com/Spring-Chobby/Chobby/blob/master/LuaUI/widgets/chobby/components/configuration.lua#L27-L47
  -- https://github.com/Spring-Chobby/Chobby/blob/master/LuaUI/widgets/chobby/components/login_window.lua#L204-L208

Implement logout

Extend the skirmish/BR menu with side, team(unit sharing) and color

These should be displayed if the game supports these options. Some sort of autodetection should be done, although it can be hardcoded until #67 gets implemented.

Disable/Remove midle click cam movement

it locks the mouse in the center of the screen and could be confusing

Modal windows and click-through

Sometimes it's possible to click through chili windows to select components underneath. This is particularly annoying when the chili theme isn't transparent.
Modal windows should also enforce that no other window/component can be clicked while the current one is being interacted with, essentially like dialogues should work.

IME handling

Support IME and specify the position where the IME should appear: https://wiki.libsdl.org/Tutorials/TextInput); chili's editbox should be updated to rely on this

Report and monitor Chili RTT bug

Chili Render To Texture can cause bugs with unresponsive controls. This has been disabled to remove the confusion during other development. Ideally RTT would be fixed upstream and reenabled. https://github.com/Spring-Chobby/Chobby

To reproduce:

• Create a list_window which has a scrollbar.
• Scroll to the bottom of the list.
• Modify the children of an item near the top of the list. One that is not visible.
• Scroll back up the list and notice that the modification has not visibly taken effect.
  The modified child will now be unresponsive. The visuals of the window are stuck on one state. Buttons are still clickable.

Unitsync engine support

Engines should be a data concept much like maps and games are, and they should be contained in their own "engines" folder (https://github.com/spring/spring/blob/4dac6507e758df6786db448db1d78c4e42b4e91a/rts/System/FileSystem/ArchiveScanner.cpp#L360-L365).

We should be able to tell which engines exist by querying VSF.GetEngineList(), and functions like Spring.Restart and Spring.Start should take an optional parameter which specifies the engine

Start the lobby in an offline mode

Ability to specify the server (either in the login window, or via settings)

Useful for development (where you often connect to a local server)

Set springsettings temporary in a startscript

Merge/use https://github.com/LebDooder/StartMenu to get a skirmish menu going

Ability to select chat text

This will require extension of editbox/textbox in chili itself (already working on it).

The login window should change visually when the login request has been sent and we're awaiting for the server response

Otherwise the user might think that the window is unresponsive.
This might be an issue with other GUI elements as well

Rapid tag and update games

Tagging games should download and install them and also save this information so that they can be updated.
VFS.TagGame()
VFS.UntagGame()
VFS.UpdateGames()
VFS.ListTaggedGames()

Channel + Private chat history

Most recent history (10-50 lines) should be displayed on join, but maybe also make it possible to see a larger amount of history (we don't want too much bloat though).

Downloaded archives aren't scanned

Need to reinitiate ArchiveScanner's rescan after a download.