This repository contains the client code for Surround, an iOS app to play Go online on the Online-Go.com server (Online Go Server - OGS). The app aims to provide the best OGS experience on iOS devices.
Surround is a fairly complex application built entirely in Swift, with the UI built mostly in SwiftUI. The project heavily uses SwiftUI previews with a lot of sample data, so I can work on the design using the same tool I use to code the app (Xcode).
I made this project open source with a permissive license in the hope that it can help improving the quality of Go apps in general. If you are working on some Go related app, I hope you can find something useful here.
- It is quite straightforward to run this project, just open the Xcode project file (
Surround.xcodeproj) with a not-too-old version of Xcode, and you should be able to build and run the project. - You might have a warning on missing a "pc file". That is a known issue caused by the Starscream library, which is a dependency of the Socket.io client library for Swift. You can ignore the warning or install
pkg-configas instructed in the issue link to silence the warning. - To use the beta site of OGS, change the
ogsRootvariable in theOGSService.swiftfile to the URL of OGS's beta site (https://beta.online-go.com).
Surround can run as a macOS app without any modification, just set Xcode to build and run for macOS and it should work pretty well. However, I have not done any work to optimize the app for macOS so it is pretty rough, might contains a lot of bugs.
Currently I don't have plan to work on the macOS part. If you want to use this project as a base to create your own macOS client for OGS, feel free to do so as long as you follow the terms in the license.
- Send me a message on either OGS or the OGS Forums.
- OGS Forums thread for Surround.
- Send me an email: khoahong@hey.com
This project is released under the BSD 3-Clause license. See LICENSE for details.