From 8b9344688b0af3d0bda7462841e0e9a369fddaf9 Mon Sep 17 00:00:00 2001 From: Benjamin Staneck Date: Sat, 12 Jun 2021 01:16:20 +0200 Subject: [PATCH] Add metadata --- .editorconfig | 15 + .gitattributes | 1 + .github/ISSUE_TEMPLATE/bug_report.md | 33 + .github/workflows/ci.yml | 19 + .gitignore | 35 +- .luacheckrc | 1101 ++++++++++++++++++++++++++ .vscode/extensions.json | 6 + CODE_OF_CONDUCT.md | 76 ++ CONTRIBUTING.md | 82 ++ LICENSE | 201 +++++ README.md | 88 +- 11 files changed, 1609 insertions(+), 48 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/workflows/ci.yml create mode 100644 .luacheckrc create mode 100644 .vscode/extensions.json create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..a615620 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,15 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +indent_style = tab +indent_size = 4 +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[{*.yml,*.toml,*.md}] +indent_style = spaces +indent_size = 2 diff --git a/.gitattributes b/.gitattributes index dfe0770..52c571f 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,3 @@ # Auto detect text files and perform LF normalization * text=auto +*.pbt linguist-language=Protobuf-Text-Format diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5375467 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,33 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: davidclarkdivide + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Versions (please complete the following information):** + +- Core: [e.g. 1.0.800] +- CC Version [e.g. 1.0.1] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..0c1d43c --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,19 @@ +name: CI + +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + with: + fetch-depth: 150 + + - name: Install and run Luacheck + uses: nebularg/actions-luacheck@v1 + with: + args: '--no-color -qo "011"' + annotate: warning + diff --git a/.gitignore b/.gitignore index 7dce873..54aeb0f 100644 --- a/.gitignore +++ b/.gitignore @@ -8,18 +8,31 @@ UserSettings/ # Screenshots used when publishing & for project thumbnails in the Create tab # Comment out if you want to synchronize screenshots -Screenshots/ - -# Directory created when publishing a game, excluding this allows anyone to publish without -# the "You aren't authorized" message -# No need to synchronize -PublishData/ - -# Folder created when you export templates from a game project -# No need to synchronize -Exports/ +#Screenshots/ # Directory created when migrating from an old storage format # No need to synchronize .core_backup/ -Data/Scripts/.vs/ + +# OS generated files +.DS_Store +.DS_Store? +._* +.Spotlight-V100 +.Trashes +ehthumbs.db +Thumbs.db + +# Visual Studio +.vs/ + +# Visual Studio Code +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +# Local History for Visual Studio Code +.history/ diff --git a/.luacheckrc b/.luacheckrc new file mode 100644 index 0000000..fc9118d --- /dev/null +++ b/.luacheckrc @@ -0,0 +1,1101 @@ +stds.core = { + read_globals = { + -- Classes + "AIActivity", + "AIActivity.name", + "AIActivity.owner", + "AIActivity.priority", + "AIActivity.isDebugModeEnabled", + "AIActivity.isHighestPriority", + "AIActivity.elapsedTime", + "AIActivity.type", + "AIActivity.IsA", + "AIActivityHandler", + "AIActivityHandler.isSelectedInDebugger", + "AIActivityHandler.type", + "AIActivityHandler.AddActivity", + "AIActivityHandler.RemoveActivity", + "AIActivityHandler.ClearActivities", + "AIActivityHandler.GetActivities", + "AIActivityHandler.FindActivity", + "AIActivityHandler.IsA", + "Ability", + "Ability.actionBinding", + "Ability.canActivateWhileDead", + "Ability.animation", + "Ability.canBePrevented", + "Ability.castPhaseSettings", + "Ability.executePhaseSettings", + "Ability.recoveryPhaseSettings", + "Ability.cooldownPhaseSettings", + "Ability.isEnabled", + "Ability.owner", + "Ability.type", + "Ability.GetTargetData", + "Ability.SetTargetData", + "Ability.GetCurrentPhase", + "Ability.GetPhaseTimeRemaining", + "Ability.Interrupt", + "Ability.Activate", + "Ability.AdvancePhase", + "Ability.IsA", + "AbilityPhaseSettings", + "AbilityPhaseSettings.duration", + "AbilityPhaseSettings.canMove", + "AbilityPhaseSettings.canJump", + "AbilityPhaseSettings.canRotate", + "AbilityPhaseSettings.preventsOtherAbilities", + "AbilityPhaseSettings.isTargetDataUpdated", + "AbilityPhaseSettings.facingMode", + "AbilityPhaseSettings.type", + "AbilityPhaseSettings.IsA", + "AbilityTarget", + "AbilityTarget.hitPlayer", + "AbilityTarget.hitObject", + "AbilityTarget.spreadHalfAngle", + "AbilityTarget.spreadRandomSeed", + "AbilityTarget.type", + "AbilityTarget.GetOwnerMovementRotation", + "AbilityTarget.SetOwnerMovementRotation", + "AbilityTarget.GetAimPosition", + "AbilityTarget.SetAimPosition", + "AbilityTarget.GetAimDirection", + "AbilityTarget.SetAimDirection", + "AbilityTarget.GetHitPosition", + "AbilityTarget.SetHitPosition", + "AbilityTarget.GetHitResult", + "AbilityTarget.SetHitResult", + "AbilityTarget.IsA", + "AnimatedMesh", + "AnimatedMesh.animationStance", + "AnimatedMesh.animationStancePlaybackRate", + "AnimatedMesh.animationStanceShouldLoop", + "AnimatedMesh.playbackRateMultiplier", + "AnimatedMesh.type", + "AnimatedMesh.GetAnimationNames", + "AnimatedMesh.GetAnimationStanceNames", + "AnimatedMesh.GetSocketNames", + "AnimatedMesh.GetAnimationEventNames", + "AnimatedMesh.AttachCoreObject", + "AnimatedMesh.PlayAnimation", + "AnimatedMesh.StopAnimations", + "AnimatedMesh.GetAnimationDuration", + "AnimatedMesh.SetMeshForSlot", + "AnimatedMesh.GetMeshForSlot", + "AnimatedMesh.IsA", + "AreaLight", + "AreaLight.sourceWidth", + "AreaLight.sourceHeight", + "AreaLight.barnDoorAngle", + "AreaLight.barnDoorLength", + "AreaLight.type", + "AreaLight.IsA", + "Audio", + "Audio.isSpatializationEnabled", + "Audio.isAttenuationEnabled", + "Audio.isOcclusionEnabled", + "Audio.isAutoPlayEnabled", + "Audio.isTransient", + "Audio.isAutoRepeatEnabled", + "Audio.pitch", + "Audio.volume", + "Audio.radius", + "Audio.falloff", + "Audio.isPlaying", + "Audio.length", + "Audio.currentPlaybackTime", + "Audio.fadeInTime", + "Audio.fadeOutTime", + "Audio.startTime", + "Audio.stopTime", + "Audio.type", + "Audio.Play", + "Audio.Stop", + "Audio.FadeIn", + "Audio.FadeOut", + "Audio.IsA", + "Camera", + "Camera.followPlayer", + "Camera.isOrthographic", + "Camera.fieldOfView", + "Camera.viewWidth", + "Camera.useCameraSocket", + "Camera.currentDistance", + "Camera.isDistanceAdjustable", + "Camera.minDistance", + "Camera.maxDistance", + "Camera.rotationMode", + "Camera.hasFreeControl", + "Camera.currentPitch", + "Camera.minPitch", + "Camera.maxPitch", + "Camera.isYawLimited", + "Camera.currentYaw", + "Camera.minYaw", + "Camera.maxYaw", + "Camera.lerpTime", + "Camera.isUsingCameraRotation", + "Camera.type", + "Camera.GetPositionOffset", + "Camera.SetPositionOffset", + "Camera.GetRotationOffset", + "Camera.SetRotationOffset", + "Camera.IsA", + "Color", + "Color.r", + "Color.g", + "Color.b", + "Color.a", + "Color.type", + "Color.GetDesaturated", + "Color.ToStandardHex", + "Color.ToLinearHex", + "Color.IsA", + "CoreFriendCollection", + "CoreFriendCollection.hasMoreResults", + "CoreFriendCollection.type", + "CoreFriendCollection.GetResults", + "CoreFriendCollection.GetMoreResults", + "CoreFriendCollection.IsA", + "CoreFriendCollectionEntry", + "CoreFriendCollectionEntry.id", + "CoreFriendCollectionEntry.name", + "CoreFriendCollectionEntry.type", + "CoreFriendCollectionEntry.IsA", + "CoreGameCollectionEntry", + "CoreGameCollectionEntry.id", + "CoreGameCollectionEntry.parentGameId", + "CoreGameCollectionEntry.name", + "CoreGameCollectionEntry.ownerId", + "CoreGameCollectionEntry.ownerName", + "CoreGameCollectionEntry.isPromoted", + "CoreGameCollectionEntry.type", + "CoreGameCollectionEntry.IsA", + "CoreGameInfo", + "CoreGameInfo.id", + "CoreGameInfo.parentGameId", + "CoreGameInfo.name", + "CoreGameInfo.description", + "CoreGameInfo.ownerId", + "CoreGameInfo.ownerName", + "CoreGameInfo.isQueueEnabled", + "CoreGameInfo.screenshotCount", + "CoreGameInfo.hasWorldCapture", + "CoreGameInfo.type", + "CoreGameInfo.GetTags", + "CoreGameInfo.IsA", + "CoreMesh", + "CoreMesh.meshAssetId", + "CoreMesh.team", + "CoreMesh.isTeamColorUsed", + "CoreMesh.isTeamCollisionEnabled", + "CoreMesh.isEnemyCollisionEnabled", + "CoreMesh.isCameraCollisionEnabled", + "CoreMesh.type", + "CoreMesh.GetColor", + "CoreMesh.SetColor", + "CoreMesh.ResetColor", + "CoreMesh.IsA", + "CoreObject", + "CoreObject.name", + "CoreObject.id", + "CoreObject.isVisible", + "CoreObject.visibility", + "CoreObject.isCollidable", + "CoreObject.collision", + "CoreObject.cameraCollision", + "CoreObject.isEnabled", + "CoreObject.lifeSpan", + "CoreObject.isStatic", + "CoreObject.isNetworked", + "CoreObject.isClientOnly", + "CoreObject.isServerOnly", + "CoreObject.parent", + "CoreObject.sourceTemplateId", + "CoreObject.type", + "CoreObject.GetReference", + "CoreObject.GetTransform", + "CoreObject.SetTransform", + "CoreObject.GetPosition", + "CoreObject.SetPosition", + "CoreObject.GetRotation", + "CoreObject.SetRotation", + "CoreObject.GetScale", + "CoreObject.SetScale", + "CoreObject.GetWorldTransform", + "CoreObject.SetWorldTransform", + "CoreObject.GetWorldPosition", + "CoreObject.SetWorldPosition", + "CoreObject.GetWorldRotation", + "CoreObject.SetWorldRotation", + "CoreObject.GetWorldScale", + "CoreObject.SetWorldScale", + "CoreObject.GetVelocity", + "CoreObject.SetVelocity", + "CoreObject.GetAngularVelocity", + "CoreObject.SetAngularVelocity", + "CoreObject.SetLocalAngularVelocity", + "CoreObject.GetChildren", + "CoreObject.AttachToPlayer", + "CoreObject.AttachToLocalView", + "CoreObject.Detach", + "CoreObject.GetAttachedToSocketName", + "CoreObject.IsVisibleInHierarchy", + "CoreObject.IsCollidableInHierarchy", + "CoreObject.IsCameraCollidableInHierarchy", + "CoreObject.IsEnabledInHierarchy", + "CoreObject.FindAncestorByName", + "CoreObject.FindChildByName", + "CoreObject.FindDescendantByName", + "CoreObject.FindDescendantsByName", + "CoreObject.FindAncestorByType", + "CoreObject.FindChildByType", + "CoreObject.FindDescendantByType", + "CoreObject.FindDescendantsByType", + "CoreObject.FindTemplateRoot", + "CoreObject.IsAncestorOf", + "CoreObject.MoveTo", + "CoreObject.MoveContinuous", + "CoreObject.Follow", + "CoreObject.StopMove", + "CoreObject.RotateTo", + "CoreObject.RotateContinuous", + "CoreObject.LookAt", + "CoreObject.LookAtContinuous", + "CoreObject.LookAtLocalView", + "CoreObject.StopRotate", + "CoreObject.ScaleTo", + "CoreObject.ScaleContinuous", + "CoreObject.StopScale", + "CoreObject.Destroy", + "CoreObject.GetCustomProperties", + "CoreObject.GetCustomProperty", + "CoreObject.SetNetworkedCustomProperty", + "CoreObject.IsA", + "CoreObjectReference", + "CoreObjectReference.id", + "CoreObjectReference.isAssigned", + "CoreObjectReference.type", + "CoreObjectReference.GetObject", + "CoreObjectReference.WaitForObject", + "CoreObjectReference.IsA", + "CorePlayerProfile", + "CorePlayerProfile.id", + "CorePlayerProfile.name", + "CorePlayerProfile.description", + "CorePlayerProfile.type", + "CorePlayerProfile.IsA", + "CurveKey", + "CurveKey.interpolation", + "CurveKey.time", + "CurveKey.value", + "CurveKey.arriveTangent", + "CurveKey.leaveTangent", + "CurveKey.type", + "CurveKey.IsA", + "Damage", + "Damage.amount", + "Damage.reason", + "Damage.sourceAbility", + "Damage.sourcePlayer", + "Damage.type", + "Damage.GetHitResult", + "Damage.SetHitResult", + "Damage.IsA", + "Decal", + "Decal.type", + "Decal.IsA", + "Equipment", + "Equipment.owner", + "Equipment.socket", + "Equipment.type", + "Equipment.GetAbilities", + "Equipment.Equip", + "Equipment.Unequip", + "Equipment.AddAbility", + "Equipment.IsA", + "Event", + "Event.type", + "Event.Connect", + "Event.IsA", + "EventListener", + "EventListener.isConnected", + "EventListener.type", + "EventListener.Disconnect", + "EventListener.IsA", + "Folder", + "Folder.type", + "Folder.IsA", + "FourWheeledVehicle", + "FourWheeledVehicle.turnRadius", + "FourWheeledVehicle.type", + "FourWheeledVehicle.IsA", + "HitResult", + "HitResult.other", + "HitResult.socketName", + "HitResult.type", + "HitResult.GetImpactPosition", + "HitResult.GetImpactNormal", + "HitResult.GetTransform", + "HitResult.IsA", + "Hook", + "Hook.type", + "Hook.Connect", + "Hook.IsA", + "HookListener", + "HookListener.isConnected", + "HookListener.priority", + "HookListener.type", + "HookListener.Disconnect", + "HookListener.IsA", + "ImpactData", + "ImpactData.targetObject", + "ImpactData.projectile", + "ImpactData.sourceAbility", + "ImpactData.weapon", + "ImpactData.weaponOwner", + "ImpactData.isHeadshot", + "ImpactData.travelDistance", + "ImpactData.type", + "ImpactData.GetHitResult", + "ImpactData.GetHitResults", + "ImpactData.IsA", + "LeaderboardEntry", + "LeaderboardEntry.id", + "LeaderboardEntry.name", + "LeaderboardEntry.score", + "LeaderboardEntry.additionalData", + "LeaderboardEntry.type", + "LeaderboardEntry.IsA", + "Light", + "Light.intensity", + "Light.attenuationRadius", + "Light.isShadowCaster", + "Light.hasTemperature", + "Light.temperature", + "Light.team", + "Light.isTeamColorUsed", + "Light.type", + "Light.GetColor", + "Light.SetColor", + "Light.IsA", + "MergedModel", + "MergedModel.type", + "MergedModel.IsA", + "NetReference", + "NetReference.isAssigned", + "NetReference.referenceType", + "NetReference.type", + "NetReference.IsA", + "NetworkContext", + "NetworkContext.type", + "NetworkContext.IsA", + "Object", + "Object.serverUserData", + "Object.clientUserData", + "Object.type", + "Object.IsA", + "Player", + "Player.id", + "Player.name", + "Player.team", + "Player.hitPoints", + "Player.maxHitPoints", + "Player.kills", + "Player.deaths", + "Player.isSpawned", + "Player.isDead", + "Player.mass", + "Player.isAccelerating", + "Player.isCrouching", + "Player.isFlying", + "Player.isGrounded", + "Player.isJumping", + "Player.isMounted", + "Player.isSwimming", + "Player.isWalking", + "Player.isSliding", + "Player.maxWalkSpeed", + "Player.stepHeight", + "Player.maxAcceleration", + "Player.brakingDecelerationFalling", + "Player.brakingDecelerationWalking", + "Player.groundFriction", + "Player.brakingFrictionFactor", + "Player.walkableFloorAngle", + "Player.lookSensitivity", + "Player.animationStance", + "Player.activeEmote", + "Player.currentFacingMode", + "Player.desiredFacingMode", + "Player.maxJumpCount", + "Player.flipOnMultiJump", + "Player.shouldFlipOnMultiJump", + "Player.jumpVelocity", + "Player.gravityScale", + "Player.maxSwimSpeed", + "Player.touchForceFactor", + "Player.isCrouchEnabled", + "Player.buoyancy", + "Player.isVisible", + "Player.isVisibleToSelf", + "Player.spreadModifier", + "Player.currentSpread", + "Player.canMount", + "Player.shouldDismountWhenDamaged", + "Player.movementControlMode", + "Player.lookControlMode", + "Player.isMovementEnabled", + "Player.isCollidable", + "Player.parentCoreObject", + "Player.spawnMode", + "Player.respawnMode", + "Player.respawnDelay", + "Player.respawnTimeRemaining", + "Player.occupiedVehicle", + "Player.currentRotationRate", + "Player.defaultRotationRate", + "Player.type", + "Player.GetWorldTransform", + "Player.SetWorldTransform", + "Player.GetWorldPosition", + "Player.SetWorldPosition", + "Player.GetWorldRotation", + "Player.SetWorldRotation", + "Player.GetWorldScale", + "Player.SetWorldScale", + "Player.GetVelocity", + "Player.GetAbilities", + "Player.GetEquipment", + "Player.GetAttachedObjects", + "Player.AddImpulse", + "Player.SetVelocity", + "Player.ResetVelocity", + "Player.ApplyDamage", + "Player.EnableRagdoll", + "Player.DisableRagdoll", + "Player.SetVisibility", + "Player.GetVisibility", + "Player.GetViewWorldPosition", + "Player.GetViewWorldRotation", + "Player.Die", + "Player.Spawn", + "Player.Respawn", + "Player.Despawn", + "Player.ClearResources", + "Player.GetResources", + "Player.GetResource", + "Player.SetResource", + "Player.AddResource", + "Player.RemoveResource", + "Player.GetResourceNames", + "Player.GetResourceNamesStartingWith", + "Player.TransferToGame", + "Player.HasPerk", + "Player.GetPerkCount", + "Player.GetPerkTimeRemaining", + "Player.ActivateFlying", + "Player.ActivateWalking", + "Player.SetMounted", + "Player.GetActiveCamera", + "Player.GetDefaultCamera", + "Player.SetDefaultCamera", + "Player.GetOverrideCamera", + "Player.SetOverrideCamera", + "Player.ClearOverrideCamera", + "Player.GetLookWorldRotation", + "Player.SetLookWorldRotation", + "Player.IsBindingPressed", + "Player.AttachToCoreObject", + "Player.Detach", + "Player.GetJoinTransferData", + "Player.GetLeaveTransferData", + "Player.IsA", + "PlayerSettings", + "PlayerSettings.type", + "PlayerSettings.ApplyToPlayer", + "PlayerSettings.IsA", + "PlayerStart", + "PlayerStart.team", + "PlayerStart.playerScaleMultiplier", + "PlayerStart.spawnTemplateId", + "PlayerStart.type", + "PlayerStart.IsA", + "PlayerTransferData", + "PlayerTransferData.reason", + "PlayerTransferData.gameId", + "PlayerTransferData.type", + "PlayerTransferData.IsA", + "PointLight", + "PointLight.hasNaturalFalloff", + "PointLight.falloffExponent", + "PointLight.sourceRadius", + "PointLight.sourceLength", + "PointLight.type", + "PointLight.IsA", + "Projectile", + "Projectile.sourceAbility", + "Projectile.shouldBounceOnPlayers", + "Projectile.shouldDieOnImpact", + "Projectile.owner", + "Projectile.speed", + "Projectile.maxSpeed", + "Projectile.gravityScale", + "Projectile.drag", + "Projectile.bouncesRemaining", + "Projectile.bounciness", + "Projectile.piercesRemaining", + "Projectile.lifeSpan", + "Projectile.capsuleRadius", + "Projectile.capsuleLength", + "Projectile.homingTarget", + "Projectile.homingAcceleration", + "Projectile.type", + "Projectile.GetWorldTransform", + "Projectile.GetWorldPosition", + "Projectile.SetWorldPosition", + "Projectile.GetVelocity", + "Projectile.SetVelocity", + "Projectile.Destroy", + "Projectile.IsA", + "Quaternion", + "Quaternion.x", + "Quaternion.y", + "Quaternion.z", + "Quaternion.w", + "Quaternion.type", + "Quaternion.GetRotation", + "Quaternion.GetForwardVector", + "Quaternion.GetRightVector", + "Quaternion.GetUpVector", + "Quaternion.IsA", + "RandomStream", + "RandomStream.seed", + "RandomStream.type", + "RandomStream.GetInitialSeed", + "RandomStream.Reset", + "RandomStream.Mutate", + "RandomStream.GetNumber", + "RandomStream.GetInteger", + "RandomStream.GetVector3", + "RandomStream.GetVector3FromCone", + "RandomStream.IsA", + "Rotation", + "Rotation.x", + "Rotation.y", + "Rotation.z", + "Rotation.type", + "Rotation.IsA", + "Script", + "Script.context", + "Script.type", + "Script.IsA", + "ScriptAsset", + "ScriptAsset.name", + "ScriptAsset.id", + "ScriptAsset.type", + "ScriptAsset.GetCustomProperties", + "ScriptAsset.GetCustomProperty", + "ScriptAsset.IsA", + "SimpleCurve", + "SimpleCurve.preExtrapolation", + "SimpleCurve.postExtrapolation", + "SimpleCurve.defaultValue", + "SimpleCurve.minTime", + "SimpleCurve.maxTime", + "SimpleCurve.minValue", + "SimpleCurve.maxValue", + "SimpleCurve.type", + "SimpleCurve.GetValue", + "SimpleCurve.GetSlope", + "SimpleCurve.IsA", + "SmartAudio", + "SmartAudio.isSpatializationEnabled", + "SmartAudio.isAttenuationEnabled", + "SmartAudio.isOcclusionEnabled", + "SmartAudio.fadeInTime", + "SmartAudio.fadeOutTime", + "SmartAudio.startTime", + "SmartAudio.stopTime", + "SmartAudio.isAutoPlayEnabled", + "SmartAudio.isTransient", + "SmartAudio.isAutoRepeatEnabled", + "SmartAudio.pitch", + "SmartAudio.volume", + "SmartAudio.radius", + "SmartAudio.falloff", + "SmartAudio.isPlaying", + "SmartAudio.type", + "SmartAudio.Play", + "SmartAudio.Stop", + "SmartAudio.FadeIn", + "SmartAudio.FadeOut", + "SmartAudio.IsA", + "SmartObject", + "SmartObject.team", + "SmartObject.isTeamColorUsed", + "SmartObject.type", + "SmartObject.GetSmartProperties", + "SmartObject.GetSmartProperty", + "SmartObject.SetSmartProperty", + "SmartObject.IsA", + "SpotLight", + "SpotLight.hasNaturalFalloff", + "SpotLight.falloffExponent", + "SpotLight.sourceRadius", + "SpotLight.sourceLength", + "SpotLight.innerConeAngle", + "SpotLight.outerConeAngle", + "SpotLight.type", + "SpotLight.IsA", + "StaticMesh", + "StaticMesh.isSimulatingDebrisPhysics", + "StaticMesh.type", + "StaticMesh.IsA", + "Task", + "Task.repeatInterval", + "Task.repeatCount", + "Task.id", + "Task.type", + "Task.Cancel", + "Task.GetStatus", + "Task.IsA", + "Terrain", + "Terrain.type", + "Terrain.IsA", + "Transform", + "Transform.type", + "Transform.GetRotation", + "Transform.SetRotation", + "Transform.GetPosition", + "Transform.SetPosition", + "Transform.GetScale", + "Transform.SetScale", + "Transform.GetQuaternion", + "Transform.SetQuaternion", + "Transform.GetForwardVector", + "Transform.GetRightVector", + "Transform.GetUpVector", + "Transform.GetInverse", + "Transform.TransformPosition", + "Transform.TransformDirection", + "Transform.IsA", + "TreadedVehicle", + "TreadedVehicle.turnSpeed", + "TreadedVehicle.type", + "TreadedVehicle.IsA", + "Trigger", + "Trigger.isInteractable", + "Trigger.interactionLabel", + "Trigger.team", + "Trigger.isTeamCollisionEnabled", + "Trigger.isEnemyCollisionEnabled", + "Trigger.type", + "Trigger.IsOverlapping", + "Trigger.GetOverlappingObjects", + "Trigger.IsA", + "UIButton", + "UIButton.text", + "UIButton.fontSize", + "UIButton.isInteractable", + "UIButton.shouldClipToSize", + "UIButton.shouldScaleToFit", + "UIButton.type", + "UIButton.SetImage", + "UIButton.GetButtonColor", + "UIButton.SetButtonColor", + "UIButton.GetHoveredColor", + "UIButton.SetHoveredColor", + "UIButton.GetPressedColor", + "UIButton.SetPressedColor", + "UIButton.GetDisabledColor", + "UIButton.SetDisabledColor", + "UIButton.GetFontColor", + "UIButton.SetFontColor", + "UIButton.SetFont", + "UIButton.GetShadowColor", + "UIButton.SetShadowColor", + "UIButton.GetShadowOffset", + "UIButton.SetShadowOffset", + "UIButton.IsA", + "UIContainer", + "UIContainer.opacity", + "UIContainer.type", + "UIContainer.IsA", + "UIControl", + "UIControl.x", + "UIControl.y", + "UIControl.width", + "UIControl.height", + "UIControl.rotationAngle", + "UIControl.anchor", + "UIControl.dock", + "UIControl.type", + "UIControl.IsA", + "UIImage", + "UIImage.isTeamColorUsed", + "UIImage.team", + "UIImage.shouldClipToSize", + "UIImage.isFlippedHorizontal", + "UIImage.isFlippedVertical", + "UIImage.type", + "UIImage.GetColor", + "UIImage.SetColor", + "UIImage.SetImage", + "UIImage.SetPlayerProfile", + "UIImage.GetImage", + "UIImage.GetShadowColor", + "UIImage.SetShadowColor", + "UIImage.GetShadowOffset", + "UIImage.SetShadowOffset", + "UIImage.IsA", + "UIPanel", + "UIPanel.shouldClipChildren", + "UIPanel.opacity", + "UIPanel.type", + "UIPanel.IsA", + "UIPerkPurchaseButton", + "UIPerkPurchaseButton.isInteractable", + "UIPerkPurchaseButton.type", + "UIPerkPurchaseButton.SetPerkReference", + "UIPerkPurchaseButton.GetPerkReference", + "UIPerkPurchaseButton.IsA", + "UIProgressBar", + "UIProgressBar.progress", + "UIProgressBar.fillType", + "UIProgressBar.type", + "UIProgressBar.SetFillImage", + "UIProgressBar.GetFillImage", + "UIProgressBar.SetBackgroundImage", + "UIProgressBar.GetBackgroundImage", + "UIProgressBar.GetFillColor", + "UIProgressBar.SetFillColor", + "UIProgressBar.GetBackgroundColor", + "UIProgressBar.SetBackgroundColor", + "UIProgressBar.IsA", + "UIScrollPanel", + "UIScrollPanel.orientation", + "UIScrollPanel.scrollPosition", + "UIScrollPanel.contentLength", + "UIScrollPanel.type", + "UIScrollPanel.IsA", + "UIText", + "UIText.text", + "UIText.fontSize", + "UIText.outlineSize", + "UIText.justification", + "UIText.shouldWrapText", + "UIText.shouldClipText", + "UIText.shouldScaleToFit", + "UIText.type", + "UIText.GetColor", + "UIText.SetColor", + "UIText.ComputeApproximateSize", + "UIText.SetFont", + "UIText.GetShadowColor", + "UIText.SetShadowColor", + "UIText.GetShadowOffset", + "UIText.SetShadowOffset", + "UIText.GetOutlineColor", + "UIText.SetOutlineColor", + "UIText.IsA", + "Vector2", + "Vector2.x", + "Vector2.y", + "Vector2.size", + "Vector2.sizeSquared", + "Vector2.type", + "Vector2.GetNormalized", + "Vector2.IsA", + "Vector3", + "Vector3.x", + "Vector3.y", + "Vector3.z", + "Vector3.size", + "Vector3.sizeSquared", + "Vector3.type", + "Vector3.GetNormalized", + "Vector3.IsA", + "Vector4", + "Vector4.x", + "Vector4.y", + "Vector4.z", + "Vector4.w", + "Vector4.size", + "Vector4.sizeSquared", + "Vector4.type", + "Vector4.GetNormalized", + "Vector4.IsA", + "Vehicle", + "Vehicle.isAccelerating", + "Vehicle.driver", + "Vehicle.mass", + "Vehicle.maxSpeed", + "Vehicle.accelerationRate", + "Vehicle.brakeStrength", + "Vehicle.tireFriction", + "Vehicle.gravityScale", + "Vehicle.isDriverHidden", + "Vehicle.isDriverAttached", + "Vehicle.isBrakeEngaged", + "Vehicle.isHandbrakeEngaged", + "Vehicle.driverAnimationStance", + "Vehicle.enterTrigger", + "Vehicle.camera", + "Vehicle.type", + "Vehicle.GetPhysicsBodyOffset", + "Vehicle.GetPhysicsBodyScale", + "Vehicle.SetDriver", + "Vehicle.RemoveDriver", + "Vehicle.AddImpulse", + "Vehicle.GetDriverPosition", + "Vehicle.GetDriverRotation", + "Vehicle.IsA", + "Vfx", + "Vfx.type", + "Vfx.Play", + "Vfx.Stop", + "Vfx.IsA", + "Weapon", + "Weapon.attackCooldownDuration", + "Weapon.animationStance", + "Weapon.multiShotCount", + "Weapon.burstCount", + "Weapon.shotsPerSecond", + "Weapon.shouldBurstStopOnRelease", + "Weapon.isHitscan", + "Weapon.range", + "Weapon.damage", + "Weapon.directDamage", + "Weapon.projectileTemplateId", + "Weapon.muzzleFlashTemplateId", + "Weapon.trailTemplateId", + "Weapon.beamTemplateId", + "Weapon.impactSurfaceTemplateId", + "Weapon.impactProjectileTemplateId", + "Weapon.impactPlayerTemplateId", + "Weapon.projectileSpeed", + "Weapon.projectileLifeSpan", + "Weapon.projectileGravity", + "Weapon.projectileLength", + "Weapon.projectileRadius", + "Weapon.projectileDrag", + "Weapon.projectileBounceCount", + "Weapon.projectilePierceCount", + "Weapon.maxAmmo", + "Weapon.currentAmmo", + "Weapon.ammoType", + "Weapon.isAmmoFinite", + "Weapon.outOfAmmoSoundId", + "Weapon.reloadSoundId", + "Weapon.spreadMin", + "Weapon.spreadMax", + "Weapon.spreadAperture", + "Weapon.spreadDecreaseSpeed", + "Weapon.spreadIncreasePerShot", + "Weapon.spreadPenaltyPerShot", + "Weapon.type", + "Weapon.HasAmmo", + "Weapon.Attack", + "Weapon.IsA", + "WorldText", + "WorldText.text", + "WorldText.type", + "WorldText.GetColor", + "WorldText.SetColor", + "WorldText.SetFont", + "WorldText.IsA", + -- Namespaces + "Chat", + "CoreDebug", + "CoreMath", + "CorePlatform", + "CoreSocial", + "CoreString", + "Environment", + "Events", + "Game", + "Leaderboards", + "Storage", + "Teams", + "UI", + "World", + -- Enums + "AbilityFacingMode", + "AbilityFacingMode.NONE", + "AbilityFacingMode.MOVEMENT", + "AbilityFacingMode.AIM", + "AbilityPhase", + "AbilityPhase.READY", + "AbilityPhase.CAST", + "AbilityPhase.EXECUTE", + "AbilityPhase.RECOVERY", + "AbilityPhase.COOLDOWN", + "BroadcastEventResultCode", + "BroadcastEventResultCode.SUCCESS", + "BroadcastEventResultCode.FAILURE", + "BroadcastEventResultCode.EXCEEDED_SIZE_LIMIT", + "BroadcastEventResultCode.EXCEEDED_RATE_WARNING_LIMIT", + "BroadcastEventResultCode.EXCEEDED_RATE_LIMIT", + "BroadcastMessageResultCode", + "BroadcastMessageResultCode.SUCCESS", + "BroadcastMessageResultCode.FAILURE", + "BroadcastMessageResultCode.EXCEEDED_SIZE_LIMIT", + "BroadcastMessageResultCode.EXCEEDED_RATE_WARNING_LIMIT", + "BroadcastMessageResultCode.EXCEEDED_RATE_LIMIT", + "Collision", + "Collision.INHERIT", + "Collision.FORCE_ON", + "Collision.FORCE_OFF", + "CoreModalType", + "CoreModalType.PAUSE_MENU", + "CoreModalType.CHARACTER_PICKER", + "CoreModalType.MOUNT_PICKER", + "CoreModalType.EMOTE_PICKER", + "CurveExtrapolation", + "CurveExtrapolation.CYCLE", + "CurveExtrapolation.CYCLE_WITH_OFFSET", + "CurveExtrapolation.OSCILLATE", + "CurveExtrapolation.LINEAR", + "CurveExtrapolation.CONSTANT", + "CurveInterpolation", + "CurveInterpolation.LINEAR", + "CurveInterpolation.CONSTANT", + "CurveInterpolation.CUBIC", + "DamageReason", + "DamageReason.UNKNOWN", + "DamageReason.COMBAT", + "DamageReason.FRIENDLY_FIRE", + "DamageReason.MAP", + "DamageReason.NPC", + "FacingMode", + "FacingMode.FACE_AIM_WHEN_ACTIVE", + "FacingMode.FACE_AIM_ALWAYS", + "FacingMode.FACE_MOVEMENT", + "LeaderboardType", + "LeaderboardType.GLOBAL", + "LeaderboardType.DAILY", + "LeaderboardType.WEEKLY", + "LeaderboardType.MONTHLY", + "LookControlMode", + "LookControlMode.NONE", + "LookControlMode.RELATIVE", + "LookControlMode.LOOK_AT_CURSOR", + "MovementControlMode", + "MovementControlMode.NONE", + "MovementControlMode.LOOK_RELATIVE", + "MovementControlMode.VIEW_RELATIVE", + "MovementControlMode.FACING_RELATIVE", + "MovementControlMode.FIXED_AXES", + "MovementMode", + "MovementMode.NONE", + "MovementMode.WALKING", + "MovementMode.FALLING", + "MovementMode.SWIMMING", + "MovementMode.FLYING", + "MovementMode.SLIDING", + "NetReferenceType", + "NetReferenceType.LEADERBOARD", + "NetReferenceType.SHARED_STORAGE", + "NetReferenceType.CREATOR_PERK", + "NetReferenceType.UNKNOWN", + "Orientation", + "Orientation.HORIZONTAL", + "Orientation.VERTICAL", + "PlayerTransferReason", + "PlayerTransferReason.UNKNOWN", + "PlayerTransferReason.CHARACTER", + "PlayerTransferReason.CREATE", + "PlayerTransferReason.SHOP", + "PlayerTransferReason.BROWSE", + "PlayerTransferReason.SOCIAL", + "PlayerTransferReason.PORTAL", + "PlayerTransferReason.AFK", + "PlayerTransferReason.EXIT", + "ProgressBarFillType", + "ProgressBarFillType.LEFT_TO_RIGHT", + "ProgressBarFillType.RIGHT_TO_LEFT", + "ProgressBarFillType.TOP_TO_BOTTOM", + "ProgressBarFillType.BOTTOM_TO_TOP", + "ProgressBarFillType.FROM_CENTER", + "RespawnMode", + "RespawnMode.NONE", + "RespawnMode.IN_PLACE", + "RespawnMode.ROUND_ROBIN", + "RespawnMode.AT_CLOSEST_SPAWN_POINT", + "RespawnMode.FARTHEST_FROM_OTHER_PLAYERS", + "RespawnMode.FARTHEST_FROM_ENEMY", + "RespawnMode.RANDOM", + "RotationMode", + "RotationMode.CAMERA", + "RotationMode.NONE", + "RotationMode.LOOK_ANGLE", + "StorageResultCode", + "StorageResultCode.SUCCESS", + "StorageResultCode.FAILURE", + "StorageResultCode.STORAGE_DISABLED", + "StorageResultCode.EXCEEDED_SIZE_LIMIT", + "TaskStatus", + "TaskStatus.UNINITIALIZED", + "TaskStatus.SCHEDULED", + "TaskStatus.RUNNING", + "TaskStatus.COMPLETED", + "TaskStatus.YIELDED", + "TaskStatus.FAILED", + "TaskStatus.CANCELED", + "TaskStatus.BLOCKED", + "TextJustify", + "TextJustify.LEFT", + "TextJustify.CENTER", + "TextJustify.RIGHT", + "UIPivot", + "UIPivot.TOP_LEFT", + "UIPivot.TOP_CENTER", + "UIPivot.TOP_RIGHT", + "UIPivot.MIDDLE_LEFT", + "UIPivot.MIDDLE_CENTER", + "UIPivot.MIDDLE_RIGHT", + "UIPivot.BOTTOM_LEFT", + "UIPivot.BOTTOM_CENTER", + "UIPivot.BOTTOM_RIGHT", + "UIPivot.CUSTOM", + "Visibility", + "Visibility.INHERIT", + "Visibility.FORCE_ON", + "Visibility.FORCE_OFF", + -- Global Functions + "warn", + "Tick", + "time", + } +} + +std = "lua53+core" +max_line_length = false + +-- for "setting non-standard global variable" for local functions +allow_defined = true + +exclude_files = { + ".luacheckrc" +} + +ignore = { + "211", -- Unused local variable + "212", -- Unused argument + "213", -- Unused loop variable + -- "231", -- Set but never accessed + "311", -- Value assigned to a local variable is unused + "314", -- Value of a field in a table literal is unused + "42.", -- Shadowing a local variable, an argument, a loop variable. + "43.", -- Shadowing an upvalue, an upvalue argument, an upvalue loop variable. + "542", -- An empty if branch + "6." , -- Whitespace + "131/.*Tick", -- Allow unused `Tick` + "131" -- Unused implicitly defined global variable. Luacheck does not understand how our require works. +} + +globals = { + "_G", + "script" +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..5fbd078 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,6 @@ +{ + "recommendations": [ + "EditorConfig.EditorConfig", + "manticoregames.vscode-core" + ] +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..893d9fc --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at docs@coregames.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0700196 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,82 @@ +# Contributing + +Interested in contributing to Strike Team? Want to report a bug? +Have a question? Before you do, please read the following guidelines. + +## Submission context + +### Got a question or problem? + +For quick questions there's no need to open an issue as you can reach us on +[Discord][1]. + +[1]: https://bit.ly/strike-team + +### Found a bug? + +If you found a bug in the source code, you can help us by submitting an issue +to the [issue tracker][2] in our GitHub repository. Even better, you can submit +a Pull Request with a fix. However, before doing so, please read the +[submission guidelines][3]. + +[2]: https://github.com/Core-Team-META/Strike-Team/ +[3]: #submission-guidelines + +### Missing a feature? + +You can request a new feature by submitting an issue to our GitHub Repository. +If you would like to implement a new feature, please submit an issue with a +proposal for your work first, to be sure that it is of use for everyone, as +we have our own goals for Strike Team. Please consider what kind of change +it is: + +- For a **major feature**, first open an issue and outline your proposal so + that it can be discussed. This will also allow us to better coordinate our + efforts, prevent duplication of work, and help you to craft the change so + that it is successfully accepted into the project. + +- **Small features and bugs** can be crafted and directly submitted as a Pull + Request. However, there is no guarantee that your feature will make it into + the `master`, as it's always a matter of opinion whether if benefits the + overall functionality of the project. + +## Submission guidelines + +### Submitting an issue + +Before you submit an issue, please search the issue tracker, maybe an issue for +your problem already exists and the discussion might inform you of workarounds +readily available. + +We want to fix all the issues as soon as possible, but before fixing a bug we +need to reproduce and confirm it. In order to reproduce bugs we will +systematically ask you to provide a minimal reproduction scenario using the +custom issue template. Please stick to the issue template. + +Unfortunately we are not able to investigate / fix bugs without a minimal +reproduction scenario, so if we don't hear back from you we may close the issue. + +### Submitting a Pull Request (PR) + +Search GitHub for an open or closed PR that relates to your submission. You +don't want to duplicate effort. If you do not find a related issue or PR, +go ahead. + +1. **Development**: Fork the project, set up the development environment, + by installing [EditorConfig][4] and [luacheck][5] plugins for your editor, make your + changes in a separate git branch and add descriptive messages to + your commits. + +2. **Build**: Before submitting a pull requests, run luacheck and make there + are no errors. This is a mandatory requirement for your PR to get accepted. + +3. **Pull Request**: After making sure everything passes, commit your changes, + push your branch to GitHub and send a PR to `Core-Team-META/Strike-Team:Dev`. + If we suggest changes, make the required updates, rebase your branch and push the + changes to your GitHub repository, which will automatically update your PR. + +After your PR is merged, you can safely delete your branch and pull the changes +from the main (upstream) repository. + +[4]: https://EditorConfig.org +[5]: https://github.com/luarocks/luacheck diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /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 index 627e046..c15a305 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,53 @@ -# META-CC-Slideshow - ## Meta Portal Slideshow - README - v0.1.0 - 2021/5/27 - Developed by: Divided (META) (https://www.coregames.com/user/eaba4947069846dbb72fc5efb0f04f47) - Modified by: Morticai (META) (https://www.coregames.com/user/d1073dbcc404405cbef8ce728e53d380) - This package is a work in progress. -## Description: - Meta Portal Slideshow is a simple component that allows creators to upload custom images that can - be used in their game to provide information to players, such as how to play, game updates, and item - showcasing. - - +
+ +# CC-Slideshow + +A simple component that allows creators to upload custom images that can be used in their game to provide information to players, such as how to play, game updates, and item showcasing. + +[![Build Status](https://github.com/Core-Team-META/CC-Slideshow/workflows/CI/badge.svg)](https://github.com/Core-Team-META/CC-Slideshow/actions/workflows/ci.yml?query=workflow%3ACI%29) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/Core-Team-META/CC-Slideshow?style=plastic) + +![TitleCard](/Screenshots/PORTAL_SLIDESHOW.png) + +
+ +## Overview + +**This package is a work in progress.** + +META Portal Slideshow is a simple component that allows creators to upload custom images that can be used in their game to provide information to players, such as how to play, game updates, and item showcasing. + ## Setup - ===== - 1. To begin adjusting how the Portal Slideshow system first selects the SlideshowSettings Client Context. - 2. Once selected you'll see several options available to you: - 1) Enabled - Make sure this is checked to enable the component. - 2) ToggleUIKeybind - The keybind players will use to toggle the tutorial on / off. T is the default. - 3) LeftJumpKeybind - Keybind players can press to move left in the slideshow. The left arrow key is the default. - 4) RightJumpKeybind - Keybind players can press to move right in the slideshow. The right arrow key is the default. - 5) TotalImages - The total amount of images to be shown in your slide show. - 6) ImageSpacing - The width of each image in the slide show. Default is 1000, which has no spacing between images. - Increasing this to say 1200 will add a slight gap between each image in the slide show. - 7) ImageZoom - Increasing this number will make the images further from the players screen. Setting this to 5 will - make the image fullscreen. + +1. To begin adjusting how the Portal Slideshow system first selects the SlideshowSettings Client Context. +2. Once selected you'll see several options available to you: + +- Enabled - Make sure this is checked to enable the component. +- ToggleUIKeybind - The keybind players will use to toggle the tutorial on / off. T is the default. +- LeftJumpKeybind - Keybind players can press to move left in the slideshow. The left arrow key is the default. +- RightJumpKeybind - Keybind players can press to move right in the slideshow. The right arrow key is the default. +- TotalImages - The total amount of images to be shown in your slide show. +- ImageSpacing - The width of each image in the slide show. Default is 1000, which has no spacing between images. + - Increasing this to say 1200 will add a slight gap between each image in the slide show. +- ImageZoom - Increasing this number will make the images further from the players screen. Setting this to 5 will + make the image fullscreen. + ## Adding Images - ============= - 1. To add images to your slideshow, you first must upload the images to a live Core Game. The game can be a blank - unlisted project, to better organize your images. When publishing the game, simply add your images as screenshots. - 2. Once published, save the link somewhere it's easily accessible on your computer. - You should have a link such as: - https://www.coregames.com/games/1b3aa6/meta-portal-image-examples - 3. Copy Game ID info in the link to your clipboard such as: - 1b3aa6/meta-portal-image-examples - 4. Under SlideshowSettings > ScreenGroup > Pivot - There will be five Game Portals as default. Simply click on each portal and change the Game ID to the Game ID where your images will be stored. - Note: Multiple projects can be used if your game requires more than 5 slideshow images. Simply repeat all steps above - but make sure to adjust the Screenshot Index of the new images to match up with the index of any further published - screenshot games. + +1. To add images to your slideshow, you first must upload the images to a live Core Game. The game can be a blank +unlisted project, to better organize your images. When publishing the game, simply add your images as screenshots. +2. Once published, save the link somewhere it's easily accessible on your computer. +You should have a link such as: + +3. Copy Game ID info in the link to your clipboard such as: `1b3aa6/meta-portal-image-examples`. +4. Under SlideshowSettings > ScreenGroup > Pivot + +There will be five Game Portals as default. Simply click on each portal and change the Game ID to the Game ID where your images will be stored. +Note: Multiple projects can be used if your game requires more than 5 slideshow images. Simply repeat all steps above +but make sure to adjust the Screenshot Index of the new images to match up with the index of any further published +screenshot games. + +## Credits + +Developed by: [Divided (META)](https://www.coregames.com/user/eaba4947069846dbb72fc5efb0f04f47) +Modified by: [Morticai (META)](https://www.coregames.com/user/d1073dbcc404405cbef8ce728e53d380)