diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b25c15b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*~ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4e8058b --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# go-steamworks + +A Steamworks SDK binding for Go + +## How to use + +```go +package steamapi + +import ( + "os" + + "github.com/hajimehoshi/go-steamworks" + "golang.org/x/text/language" +) + +const appID = 480 // Rewrite this + +func init() { + if steamworks.RestartAppIfNecessary(appID) { + os.Exit(1) + } + if !steamworks.Init() { + panic("steamworks.Init failed") + } +} + +func SystemLang() language.Tag { + switch steamworks.SteamApps().GetCurrentGameLanguage() { + case "english": + return language.English + case "japanese": + return language.Japanese + } + return language.Und +} +``` + +## License + +All the source code files are licensed under Apache License 2.0. + +These binary files are copied from Steamworks SDK's `redistribution_bin` directory. You must follow [Valve Corporation Steamworks SDK Access Agreement](https://partner.steamgames.com/documentation/sdk_access_agreement) for these files: + + * `libsteam_api.dylib` + * `libsteam_api.so` + * `libsteam_api64.so` + * `steam_api.dll` + * `steam_api64.dll` + +## Resources + + * [Steamworks SDK](https://partner.steamgames.com/doc/sdk) diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..4bceac1 --- /dev/null +++ b/go.mod @@ -0,0 +1,5 @@ +module github.com/hajimehoshi/go-steamworks + +go 1.16 + +require golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf diff --git a/go.sum b/go.sum new file mode 100644 index 0000000..6a1bd00 --- /dev/null +++ b/go.sum @@ -0,0 +1,2 @@ +golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf h1:2ucpDCmfkl8Bd/FsLtiD653Wf96cW37s+iGx93zsu4k= +golang.org/x/sys v0.0.0-20210823070655-63515b42dcdf/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= diff --git a/libsteam_api.dylib b/libsteam_api.dylib new file mode 100644 index 0000000..d89750e Binary files /dev/null and b/libsteam_api.dylib differ diff --git a/libsteam_api.so b/libsteam_api.so new file mode 100644 index 0000000..bb5d4fe Binary files /dev/null and b/libsteam_api.so differ diff --git a/libsteam_api64.so b/libsteam_api64.so new file mode 100644 index 0000000..4111712 Binary files /dev/null and b/libsteam_api64.so differ diff --git a/steam_api.dll b/steam_api.dll new file mode 100644 index 0000000..8fb32b4 Binary files /dev/null and b/steam_api.dll differ diff --git a/steam_api64.dll b/steam_api64.dll new file mode 100644 index 0000000..c6e55cf Binary files /dev/null and b/steam_api64.dll differ diff --git a/steamworks.go b/steamworks.go new file mode 100644 index 0000000..9404082 --- /dev/null +++ b/steamworks.go @@ -0,0 +1,15 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2021 The go-steamworks Authors + +package steamworks + +type ISteamApps interface { + GetCurrentGameLanguage() string +} + +const ( + flatAPI_RestartAppIfNecessary = "SteamAPI_RestartAppIfNecessary" + flatAPI_Init = "SteamAPI_Init" + flatAPI_SteamApps = "SteamAPI_SteamApps_v008" + flatAPI_ISteamApps_GetCurrentGameLanguage = "SteamAPI_ISteamApps_GetCurrentGameLanguage" +) diff --git a/steamworks_darwin_amd64.go b/steamworks_darwin_amd64.go new file mode 100644 index 0000000..0bffda8 --- /dev/null +++ b/steamworks_darwin_amd64.go @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2021 The go-steamworks Authors + +package steamworks + +import ( + _ "embed" +) + +//go:embed libsteam_api.dylib +var libSteamAPI []byte diff --git a/steamworks_linux_386.go b/steamworks_linux_386.go new file mode 100644 index 0000000..fae9525 --- /dev/null +++ b/steamworks_linux_386.go @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2021 The go-steamworks Authors + +package steamworks + +import ( + _ "embed" +) + +//go:embed libsteam_api.so +var libSteamAPI []byte diff --git a/steamworks_linux_amd64.go b/steamworks_linux_amd64.go new file mode 100644 index 0000000..eb251c7 --- /dev/null +++ b/steamworks_linux_amd64.go @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2021 The go-steamworks Authors + +package steamworks + +import ( + _ "embed" +) + +//go:embed libsteam_api64.so +var libSteamAPI []byte diff --git a/steamworks_unix.go b/steamworks_unix.go new file mode 100644 index 0000000..edea205 --- /dev/null +++ b/steamworks_unix.go @@ -0,0 +1,151 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2021 The go-steamworks Authors + +//go:build !js && !windows +// +build !js,!windows + +package steamworks + +import ( + _ "embed" + "fmt" + "os" + "path/filepath" + "runtime" + "unsafe" +) + +// #cgo LDFLAGS: -ldl +// +// #include +// #include +// #include +// #include +// +// static uintptr_t dlsym_(uintptr_t handle, const char* name) { +// return (uintptr_t)dlsym((void*)handle, name); +// } +// +// static const char* uintptrToChar(uintptr_t str) { +// return (const char*)str; +// } +// +// static uintptr_t callFunc_Bool(uintptr_t f) { +// return ((bool (*)())(f))(); +// } +// +// static uintptr_t callFunc_Bool_Int(uintptr_t f, int arg0) { +// return ((bool (*)(int))(f))(arg0); +// } +// +// static uintptr_t callFunc_Ptr(uintptr_t f) { +// return (uintptr_t)((void* (*)())(f))(); +// } +// +// static uintptr_t callFunc_Ptr_Ptr(uintptr_t f, uintptr_t arg0) { +// return (uintptr_t)((void* (*)(void*))(f))((void*)arg0); +// } +import "C" + +type lib struct { + lib C.uintptr_t + procs map[string]C.uintptr_t +} + +func (l *lib) call(name string, args ...uintptr) (C.uintptr_t, error) { + if l.procs == nil { + l.procs = map[string]C.uintptr_t{} + } + + if _, ok := l.procs[name]; !ok { + cname := C.CString(name) + defer C.free(unsafe.Pointer(cname)) + l.procs[name] = C.dlsym_(l.lib, cname) + } + + f := l.procs[name] + switch name { + case flatAPI_RestartAppIfNecessary: + return C.callFunc_Bool_Int(f, C.int(args[0])), nil + case flatAPI_Init: + return C.callFunc_Bool(f), nil + case flatAPI_SteamApps: + return C.callFunc_Ptr(f), nil + case flatAPI_ISteamApps_GetCurrentGameLanguage: + return C.callFunc_Ptr_Ptr(f, C.uintptr_t(args[0])), nil + } + + return 0, fmt.Errorf("steamworks: function %s not implemented", name) +} + +func loadLib() (C.uintptr_t, error) { + dir, err := os.MkdirTemp("", "") + if err != nil { + return 0, err + } + + ext := ".so" + if runtime.GOOS == "darwin" { + ext = ".dylib" + } + path := filepath.Join(dir, "libsteam_api"+ext) + if err := os.WriteFile(path, libSteamAPI, 0644); err != nil { + return 0, err + } + + cpath := C.CString(path) + defer C.free(unsafe.Pointer(cpath)) + + lib := C.uintptr_t(uintptr(C.dlopen(cpath, C.RTLD_LAZY))) + if lib == 0 { + return 0, fmt.Errorf("steamworks: dlopen failed: %s", C.GoString(C.dlerror())) + } + + return lib, nil +} + +var theLib *lib + +func init() { + l, err := loadLib() + if err != nil { + panic(err) + } + theLib = &lib{ + lib: l, + } +} + +func RestartAppIfNecessary(appID int) bool { + v, err := theLib.call(flatAPI_RestartAppIfNecessary, uintptr(appID)) + if err != nil { + panic(err) + } + return byte(v) != 0 +} + +func Init() bool { + v, err := theLib.call(flatAPI_Init) + if err != nil { + panic(err) + } + return byte(v) != 0 +} + +func SteamApps() ISteamApps { + v, err := theLib.call(flatAPI_SteamApps) + if err != nil { + panic(err) + } + return steamApps(v) +} + +type steamApps C.uintptr_t + +func (s steamApps) GetCurrentGameLanguage() string { + v, err := theLib.call(flatAPI_ISteamApps_GetCurrentGameLanguage, uintptr(s)) + if err != nil { + panic(err) + } + return C.GoString(C.uintptrToChar(v)) +} diff --git a/steamworks_windows.go b/steamworks_windows.go new file mode 100644 index 0000000..3831105 --- /dev/null +++ b/steamworks_windows.go @@ -0,0 +1,129 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2021 The go-steamworks Authors + +package steamworks + +import ( + "crypto/sha256" + "encoding/hex" + "os" + "path/filepath" + "unsafe" + + "golang.org/x/sys/windows" +) + +var steamAPIDLLHash string + +func init() { + hash := sha256.Sum256(steamAPIDLL) + steamAPIDLLHash = hex.EncodeToString(hash[:]) +} + +type dll struct { + d *windows.LazyDLL + procs map[string]*windows.LazyProc +} + +func (d *dll) call(name string, args ...uintptr) (uintptr, error) { + if d.procs == nil { + d.procs = map[string]*windows.LazyProc{} + } + if _, ok := d.procs[name]; !ok { + d.procs[name] = d.d.NewProc(name) + } + r, _, err := d.procs[name].Call(args...) + if err != nil { + errno, ok := err.(windows.Errno) + if !ok { + return r, err + } + if errno != 0 { + return r, err + } + } + return r, nil +} + +func loadDLL() (*dll, error) { + cachedir, err := os.UserCacheDir() + if err != nil { + return nil, err + } + + dir := filepath.Join(cachedir, "go-inovation") + if err := os.MkdirAll(dir, 0755); err != nil { + return nil, err + } + + fn := filepath.Join(dir, steamAPIDLLHash+".dll") + if _, err := os.Stat(fn); err != nil { + if !os.IsNotExist(err) { + return nil, err + } + if err := os.WriteFile(fn+".tmp", steamAPIDLL, 0644); err != nil { + return nil, err + } + if err := os.Rename(fn+".tmp", fn); err != nil { + return nil, err + } + } + + return &dll{ + d: windows.NewLazyDLL(fn), + }, nil +} + +var theDLL *dll + +func init() { + dll, err := loadDLL() + if err != nil { + panic(err) + } + theDLL = dll +} + +func RestartAppIfNecessary(appID int) bool { + v, err := theDLL.call(flatAPI_RestartAppIfNecessary, uintptr(appID)) + if err != nil { + panic(err) + } + return byte(v) != 0 +} + +func Init() bool { + v, err := theDLL.call(flatAPI_Init) + if err != nil { + panic(err) + } + return byte(v) != 0 +} + +func SteamApps() ISteamApps { + v, err := theDLL.call(flatAPI_SteamApps) + if err != nil { + panic(err) + } + return steamApps(v) +} + +type steamApps uintptr + +func (s steamApps) GetCurrentGameLanguage() string { + v, err := theDLL.call(flatAPI_ISteamApps_GetCurrentGameLanguage, uintptr(s)) + if err != nil { + panic(err) + } + + bs := make([]byte, 0, 256) + for i := int32(0); ; i++ { + b := *(*byte)(unsafe.Pointer(v)) + v += unsafe.Sizeof(byte(0)) + if b == 0 { + break + } + bs = append(bs, b) + } + return string(bs) +} diff --git a/steamworks_windows_386.go b/steamworks_windows_386.go new file mode 100644 index 0000000..47b5326 --- /dev/null +++ b/steamworks_windows_386.go @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2021 The go-steamworks Authors + +package steamworks + +import ( + _ "embed" +) + +//go:embed steam_api.dll +var steamAPIDLL []byte diff --git a/steamworks_windows_amd64.go b/steamworks_windows_amd64.go new file mode 100644 index 0000000..a719e17 --- /dev/null +++ b/steamworks_windows_amd64.go @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: Apache-2.0 +// Copyright 2021 The go-steamworks Authors + +package steamworks + +import ( + _ "embed" +) + +//go:embed steam_api64.dll +var steamAPIDLL []byte